BatchDataFrameOperations Classe

Wrappers orientados a DataFrame para operações de registro em lote.

Fornece create, updatee delete que aceitampandas.Series / pandas.DataFrame entradas e as convertem em ditados padrão antes de enfileirar no lote. Isso permite que os chamadores de ciência de dados alimentem DataFrames diretamente em um lote sem conversão manual.

Acessado por meio de batch.dataframe.

Exemplo:


   import pandas as pd

   batch = client.batch.new()
   df = pd.DataFrame([
       {"name": "Contoso", "telephone1": "555-0100"},
       {"name": "Fabrikam", "telephone1": "555-0200"},
   ])
   batch.dataframe.create("account", df)
   result = batch.execute()

Construtor

BatchDataFrameOperations(batch: _BatchContext)

Parâmetros

Nome	Description
batch Obrigatório

Métodos

create

O registro de enfileiramento cria a partir de um DataFrame pandas.

Cada linha se torna um registro. Todas as linhas são agrupadas em um único CreateMultiple item de lote (uma solicitação HTTP no lote).

Exemplo:


   df = pd.DataFrame([{"name": "Contoso"}, {"name": "Fabrikam"}])
   batch.dataframe.create("account", df)

delete

Enfileirar exclusões de registro de uma série pandas de GUIDs.

Exemplo:


   ids_series = pd.Series(["guid-1", "guid-2", "guid-3"])
   batch.dataframe.delete("account", ids_series)

update

Enfileirar atualizações de registro de um DataFrame pandas.

Cada linha representa uma atualização. A id_column coluna especifica qual coluna contém os GUIDs de registro.

Exemplo:


   df = pd.DataFrame([
       {"accountid": "guid-1", "telephone1": "555-0100"},
       {"accountid": "guid-2", "telephone1": "555-0200"},
   ])
   batch.dataframe.update("account", df, id_column="accountid")

create

O registro de enfileiramento cria a partir de um DataFrame pandas.

Cada linha se torna um registro. Todas as linhas são agrupadas em um único CreateMultiple item de lote (uma solicitação HTTP no lote).

Exemplo:


   df = pd.DataFrame([{"name": "Contoso"}, {"name": "Fabrikam"}])
   batch.dataframe.create("account", df)

create(table: str, records: DataFrame) -> None

Parâmetros

Nome	Description
table Obrigatório	str Nome do esquema da tabela (por exemplo `"account"`).
records Obrigatório	Dataframe DataFrame em que cada linha é um registro a ser criado.

Exceções

Tipo	Description
TypeError	Se `records` não for um DataFrame pandas.
ValueError	Se `records` estiver vazia ou qualquer linha não tiver valores não nulos.

delete

Enfileirar exclusões de registro de uma série pandas de GUIDs.

Exemplo:


   ids_series = pd.Series(["guid-1", "guid-2", "guid-3"])
   batch.dataframe.delete("account", ids_series)

delete(table: str, ids: Series, use_bulk_delete: bool = True) -> None

Parâmetros

Nome	Description
table Obrigatório	str Nome do esquema da tabela (por exemplo `"account"`).
ids Obrigatório	Series Série de GUIDs de registro a serem excluídos.
use_bulk_delete	bool Quando `True` (padrão) e `ids` tiver vários valores, use a ação `BulkDelete` . Valor padrão: True

Exceções

Tipo	Description
TypeError	Se `ids` não for uma série pandas.
ValueError	Se `ids` contiver valores inválidos.

update

Enfileirar atualizações de registro de um DataFrame pandas.

Cada linha representa uma atualização. A id_column coluna especifica qual coluna contém os GUIDs de registro.

Exemplo:


   df = pd.DataFrame([
       {"accountid": "guid-1", "telephone1": "555-0100"},
       {"accountid": "guid-2", "telephone1": "555-0200"},
   ])
   batch.dataframe.update("account", df, id_column="accountid")

update(table: str, changes: DataFrame, id_column: str, clear_nulls: bool = False) -> None

Parâmetros

Nome	Description
table Obrigatório	str Nome do esquema da tabela (por exemplo `"account"`).
changes Obrigatório	Dataframe DataFrame em que cada linha contém um GUID de registro e os campos a serem atualizados.
id_column Obrigatório	str Nome da coluna DataFrame que contém GUIDs de registro.
clear_nulls	bool Quando `False` (padrão), os valores NaN/None são ignorados. Quando `True`, NaN/None envia `null` para limpar o campo. Valor padrão: False

Exceções

Tipo	Description
TypeError	Se `changes` não for um DataFrame pandas.
ValueError	Se `changes` estiver vazio, `id_column` estiver ausente ou as IDs forem inválidas.