Delen via

read_statestore table-waardefunctie

  • Artikel

Van toepassing op:vinkje als ja aan Databricks SQL vinkje als ja aan Databricks Runtime 14.3 en hoger

Belangrijk

Deze functie is beschikbaar als openbare preview.

Een table waardefunctie voor het lezen van records uit het statusarchief van streamingquery's. De geretourneerde relatie ondersteunt alleen het uitvoeren als een batchquery.

Syntaxis

read_statestore ( path [, option_key => option_value ] [ ... ] )

Argumenten

read_statestore vereist aanroep met benoemde parameter voor de optionele parameters.

  • path: A STRING literal. Het pad van de locatie van het controlepunt voor streamingquery's.
  • option_key: De naam van de optie die u wilt configureren. U moet backticks (') gebruiken voor opties die puntjes (.) bevatten.
  • option_value: een constante expressie voor set om de optie te activeren. Accepteert letterlijke en scalaire functies.

Alle option_values zijn hoofdlettergevoelig.

option_key Type Default Beschrijving
batchId BIGINT meest recente batch-id Vertegenwoordigt de doelbatch waaruit moet worden gelezen. Deze optie wordt gebruikt wanneer gebruikers tijdreizen willen uitvoeren. De batch moet worden doorgevoerd, maar nog niet worden opgeschoond.
OperatorId BIGINT 0 Vertegenwoordigt de doeloperator waaruit moet worden gelezen. Deze optie wordt gebruikt wanneer de query meerdere stateful operators gebruikt.
storeName STRING 'DEFAULT' Vertegenwoordigt de doelzijde waaruit moet worden gelezen. Deze optie wordt gebruikt wanneer gebruikers de status van streamstream-joinwillen lezen.
joinSide STRING 'None' Vertegenwoordigt de doelzijde waaruit moet worden gelezen. Deze optie wordt gebruikt wanneer gebruikers de status van streamstream-joinwillen lezen. Een van: 'Left', 'Right', 'None'.

Retouren

De functie retourneert een resultaat set met de volgende columns.

Notitie

De geneste columns voor sleutel en waarde is sterk afhankelijk van de invoer schema van de stateful operator en het type operator.

Naam Gegevenstype Null-waarde toegestaan Standaard Beschrijving
id STRUCT Nee Sleutelrij van de stateful operator die is opgeslagen in het statuscontrolepunt.
value STRUCT Ja Waarderij van de stateful operator die is opgeslagen in het statuscontrolepunt.
partition_id INTEGER Nee De partition die de record bevat.
shardId STRING Nee Een unieke identifier voor de shard where, waaruit de gegevens zijn gelezen.
sequenceNumber BIGINT Nee Het unieke identifier van het record binnen zijn shard.
approximateArrivalTimestamp TIMESTAMP Nee De geschatte tijd dat de record in de stream is ingevoegd.

Voorbeelden

- Read from state
> SELECT * FROM read_statestore('/checkpoint/path');

– Read from state with storeName option
> SELECT * FROM read_statestore(
      '/checkpoint/path',
      operatorId => 0,
      batchId => 2,
      storeName => 'default'
  );

– Read from state with joinSide option

> SELECT * FROM read_statestore(
      '/checkpoint/path',
      joinSide => 'left'
  );