NotebookUtils business event utilities for Fabric

Käytä moduulia notebookutils.businessEvents julkaisemaan liiketoimintatapahtumia Fabric-muistikirjasta. Voit julkaista yksittäisen tapahtuman tai erän tapahtumia, jotka noudattavat liiketoimintatapahtumaskeemaa tapahtumaskeemassa.

Liiketoimintatapahtumien työkalut ovat saatavilla Python 3.12- ja PySpark (Python) -muistikirjoissa.

Seuraava taulukko listaa käytettävissä olevat menetelmät:

Menetelmä Allekirjoitus Kuvaus
help help(methodName: str = '') -> None Näyttää apua moduulille tai määritellylle menetelmälle.
publish publish(eventSchemaSetWorkspace: str, eventSchemaSet: str, eventTypeName: str, eventData: Union[Dict[str, Any], List[Dict[str, Any]]], dataVersion: str = 'v1') -> bool Julkaisee yhden tai useamman liiketoimintatapahtuman määriteltyyn tapahtumatyyppiin.

Avun hakeminen

Suorita seuraava komento saadaksesi yleiskuvan moduulista:

notebookutils.businessEvents.help()

Saadaksesi apua publish metodiin, määritä metodin nimi:

notebookutils.businessEvents.help("publish")

Julkaise liiketapahtuma

Käytä publish() lähettääksesi hyötykuorman, joka vastaa liiketoimintatapahtuman skeemaa:

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

print(f"Published: {published}")

Seuraava taulukko kuvaa parametrit:

Parametri Kirjoita Kuvaus
eventSchemaSetWorkspace merkkijono Työtilan nimi tai ID, joka sisältää tapahtumaskeeman joukon.
eventSchemaSet merkkijono Tapahtumaskeeman nimi tai ID.
eventTypeName merkkijono Liiketoimintatapahtumatyypin nimi, jota julkaista.
eventData Sanakirja tai luettelo sanakirjoista Tapahtumakuorma. Jokaisen sanakirjan on noudatettava valittua liiketoimintatapahtumakaaviota.
dataVersion merkkijono Liiketoimintatapahtuman skeeman versio. Oletusarvo on v1.

Menetelmä palautuu True , kun tapahtuma julkaistaan onnistuneesti. Jos tapahtumaa ei voida julkaista, menetelmä aiheuttaa poikkeuksen.

Julkaise useita liiketoimintatapahtumia

Jos haluat julkaista useita saman tyyppisiä tapahtumia yhdellä kutsulla, lähetä sanakirjalista osoitteeseen 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}")

Kaikkien listan hyötykuormien on noudatettava skeemaversiota, joka on määritelty .dataVersion

Huomioitavia seikkoja

  • Luo liiketoimintatapahtumatyyppi ja sen skeema ennen tapahtumien julkaisemista muistikirjasta.
  • Käytä joko nimiä tai tunnisteita ja eventSchemaSetWorkspaceeventSchemaSet.
  • Sovita ominaisuuksien nimet, tietotyypit ja vaaditut kentät eventData valittuun skeemaversioon.
  • Käsittele poikkeuksia, publish() jotta muistikirja ja putkisto suorittavat raporttien julkaisuvirheitä.