Utilitas event bisnis NotebookUtils untuk Fabric

Gunakan modul notebookutils.businessEvents untuk menerbitkan peristiwa bisnis dari notebook Fabric. Anda dapat mempublikasikan satu event atau sekumpulan event yang mengikuti skema event bisnis dalam set skema event.

Utilitas event bisnis tersedia di notebook Python 3.12 dan PySpark (Python).

Tabel berikut mencantumkan metode yang tersedia:

Method Signature Description
help help(methodName: str = '') -> None Menampilkan bantuan untuk modul atau metode yang ditentukan.
publish publish(eventSchemaSetWorkspace: str, eventSchemaSet: str, eventTypeName: str, eventData: Union[Dict[str, Any], List[Dict[str, Any]]], dataVersion: str = 'v1') -> bool Menerbitkan satu atau lebih event bisnis ke tipe event yang ditentukan.

Dapatkan bantuan

Jalankan perintah berikut untuk mendapatkan gambaran keseluruhan modul:

notebookutils.businessEvents.help()

Untuk mendapatkan bantuan untuk publish metode, tentukan nama metode:

notebookutils.businessEvents.help("publish")

Publikasikan acara bisnis

Gunakan publish() untuk mengirim payload yang sesuai dengan skema event bisnis:

published = notebookutils.businessEvents.publish(
    eventSchemaSetWorkspace="ContosoWorkspace",
    eventSchemaSet="OrderEvents",
    eventTypeName="OrderDelayed",
    eventData={
        "orderId": "12345",
        "status": "delayed",
        "reason": "weather"
    },
    dataVersion="v1"
)

print(f"Published: {published}")

Tabel berikut ini menjelaskan parameter:

Parameter Tipe Description
eventSchemaSetWorkspace string Nama atau ID ruang kerja yang berisi kumpulan skema peristiwa.
eventSchemaSet string Nama atau ID kumpulan skema peristiwa.
eventTypeName string Nama tipe acara bisnis yang akan dipublikasikan.
eventData Kamus atau daftar kamus Payload peristiwa. Setiap kamus harus sesuai dengan skema event bisnis yang dipilih.
dataVersion string Versi skema peristiwa bisnis. Defaultnya adalah v1.

Metode mengembalikan True ketika peristiwa berhasil dipublikasikan. Jika event tidak dapat dipublikasikan, metode akan mengajukan pengecualian.

Publikasikan beberapa acara bisnis

Untuk mempublikasikan beberapa event dengan tipe yang sama dalam satu panggilan, kirimkan daftar kamus ke eventData:

published = notebookutils.businessEvents.publish(
    eventSchemaSetWorkspace="ContosoWorkspace",
    eventSchemaSet="OrderEvents",
    eventTypeName="OrderDelayed",
    eventData=[
        {
            "orderId": "12345",
            "status": "delayed",
            "reason": "weather"
        },
        {
            "orderId": "12346",
            "status": "delayed",
            "reason": "traffic"
        }
    ],
    dataVersion="v1"
)

print(f"Published: {published}")

Semua payload dalam daftar harus sesuai dengan versi skema yang ditentukan oleh dataVersion.

Considerations

  • Buat tipe event bisnis dan skemanya sebelum Anda mempublikasikan event dari notebook.
  • Gunakan nama atau ID untuk eventSchemaSetWorkspace dan eventSchemaSet.
  • Cocokkan nama properti, tipe data, dan bidang yang diperlukan ke eventData versi skema yang dipilih.
  • Tangani pengecualian dari publish() agar eksekusi notebook dan pipeline melaporkan kegagalan penerbitan.

Konten terkait

  • Terakhir diperbarui pada