BatchTableOperations Classe

Operações de metadados de tabela em um BatchRequest.

client.tables Espelha exatamente: os mesmos nomes de método, as mesmas assinaturas. Todos os métodos retornam None; os resultados chegam por meio de BatchResult.

Note

tables.delete, tables.add_columns e tables.remove_columns

exigir uma pesquisa de metadados (GET EntityDefinitions) em

execute tempo para resolver o MetadadosId da tabela.

Essa pesquisa é transparente para o chamador.

Note

tables.add_columns e tables.remove_columns produzem um

item de lote por coluna, para que eles contribuam com várias entradas para

responses.

Não instanciar diretamente; use batch.tables.

Construtor

BatchTableOperations(batch: _BatchContext)

Parâmetros

Nome Description
batch
Obrigatório

Métodos

add_columns

Adicione operações de criação de coluna ao lote (uma por coluna).

A tabela é resolvida no momento da MetadataId execução. Cada coluna produz uma entrada em responses.

create

Adicione uma operação de criação de tabela ao lote.

Note

A verificação de pré-existência executada por client.tables.create é ignorada

no modo de lote. Se a tabela já existir, o servidor retornará um erro

no correspondente BatchItemResponse.

create_lookup_field

Adicionar uma criação de campo de pesquisa ao lote (wrapper de conveniência para create_one_to_many_relationship).

create_many_to_many_relationship

Adicione uma criação de relação muitos para muitos ao lote.

create_one_to_many_relationship

Adicione uma criação de relação um para muitos ao lote.

delete

Adicione uma operação de exclusão de tabela ao lote.

A tabela é resolvida por meio de uma solicitação GET no momento da MetadataId execução.

delete_relationship

Adicione uma operação de exclusão de relação ao lote.

get

Adicione uma operação de obtenção de metadados de tabela ao lote.

A resposta será feita BatchItemResponse.data após a execução.

get_relationship

Adicione uma operação de obtenção de metadados de relação ao lote.

A resposta será feita BatchItemResponse.data após a execução.

list

Adicione uma operação list-all-tables ao lote.

Espelhos client.tables.list(). Forneça uma expressão OData $filter opcional para restringir ainda mais os resultados (combinado com o IsPrivate eq false uso and). select nomes de propriedade específicos de projetos por meio de $select.

A resposta será feita BatchItemResponse.data após a execução.

remove_columns

Adicione operações de exclusão de coluna ao lote (uma por coluna).

As tabelas MetadataId e as de cada coluna são resolvidas no momento da MetadataId execução. Cada coluna produz uma entrada em responses.

add_columns

Adicione operações de criação de coluna ao lote (uma por coluna).

A tabela é resolvida no momento da MetadataId execução. Cada coluna produz uma entrada em responses.

add_columns(table: str, columns: Dict[str, Any]) -> None

Parâmetros

Nome Description
table
Obrigatório
str

Nome do esquema da tabela de destino.

columns
Obrigatório

Mapeamento de nomes de esquema de coluna para digitar cadeias de caracteres ou subclasses Enum.

create

Adicione uma operação de criação de tabela ao lote.

Note

A verificação de pré-existência executada por client.tables.create é ignorada

no modo de lote. Se a tabela já existir, o servidor retornará um erro

no correspondente BatchItemResponse.

create(table: str, columns: Dict[str, Any], *, solution: str | None = None, primary_column: str | None = None, display_name: str | None = None) -> None

Parâmetros

Nome Description
table
Obrigatório
str

Nome do esquema da nova tabela (por exemplo "new_Product").

columns
Obrigatório

Mapeamento de nomes de esquema de coluna para digitar cadeias de caracteres ou subclasses Enum.

solution
Obrigatório
str ou None

Nome exclusivo da solução opcional.

primary_column
Obrigatório
str ou None

Nome do esquema de coluna primária opcional.

display_name
Obrigatório
str ou None

Nome de exibição legível para a tabela. Quando omitido, o padrão é o nome do esquema da tabela.

Parâmetros somente de palavra-chave

Nome Description
solution
Valor padrão: None
primary_column
Valor padrão: None
display_name
Valor padrão: None

create_lookup_field

Adicionar uma criação de campo de pesquisa ao lote (wrapper de conveniência para create_one_to_many_relationship).

create_lookup_field(referencing_table: str, lookup_field_name: str, referenced_table: str, *, display_name: str | None = None, description: str | None = None, required: bool = False, cascade_delete: str = 'RemoveLink', solution: str | None = None, language_code: int = 1033) -> None

Parâmetros

Nome Description
referencing_table
Obrigatório
str

Nome lógico da tabela filho (muitos).

lookup_field_name
Obrigatório
str

Nome do esquema para o campo de pesquisa.

referenced_table
Obrigatório
str

Nome lógico da tabela pai (um).

display_name
Obrigatório
str ou None

Nome de exibição para o campo de pesquisa.

description
Obrigatório
str ou None

Descrição opcional.

required
Obrigatório

Se a pesquisa é necessária.

cascade_delete
Obrigatório
str

Exclua o comportamento em cascata.

solution
Obrigatório
str ou None

Nome exclusivo da solução opcional.

language_code
Obrigatório
int

Código de idioma para rótulos (padrão 1033).

Parâmetros somente de palavra-chave

Nome Description
display_name
Valor padrão: None
description
Valor padrão: None
required
Valor padrão: False
cascade_delete
Valor padrão: RemoveLink
solution
Valor padrão: None
language_code
Valor padrão: 1033

create_many_to_many_relationship

Adicione uma criação de relação muitos para muitos ao lote.

create_many_to_many_relationship(relationship: ManyToManyRelationshipMetadata, *, solution: str | None = None) -> None

Parâmetros

Nome Description
relationship
Obrigatório

Metadados de relação.

solution
Obrigatório
str ou None

Nome exclusivo da solução opcional.

Parâmetros somente de palavra-chave

Nome Description
solution
Valor padrão: None

create_one_to_many_relationship

Adicione uma criação de relação um para muitos ao lote.

create_one_to_many_relationship(lookup: LookupAttributeMetadata, relationship: OneToManyRelationshipMetadata, *, solution: str | None = None) -> None

Parâmetros

Nome Description
lookup
Obrigatório

Metadados de atributo de pesquisa.

relationship
Obrigatório

Metadados de relação.

solution
Obrigatório
str ou None

Nome exclusivo da solução opcional.

Parâmetros somente de palavra-chave

Nome Description
solution
Valor padrão: None

delete

Adicione uma operação de exclusão de tabela ao lote.

A tabela é resolvida por meio de uma solicitação GET no momento da MetadataId execução.

delete(table: str) -> None

Parâmetros

Nome Description
table
Obrigatório
str

Nome do esquema da tabela a ser excluída.

delete_relationship

Adicione uma operação de exclusão de relação ao lote.

delete_relationship(relationship_id: str) -> None

Parâmetros

Nome Description
relationship_id
Obrigatório
str

GUID dos metadados de relação a serem excluídos.

get

Adicione uma operação de obtenção de metadados de tabela ao lote.

A resposta será feita BatchItemResponse.data após a execução.

get(table: str) -> None

Parâmetros

Nome Description
table
Obrigatório
str

Nome do esquema da tabela.

get_relationship

Adicione uma operação de obtenção de metadados de relação ao lote.

A resposta será feita BatchItemResponse.data após a execução.

get_relationship(schema_name: str) -> None

Parâmetros

Nome Description
schema_name
Obrigatório
str

Nome do esquema da relação.

list

Adicione uma operação list-all-tables ao lote.

Espelhos client.tables.list(). Forneça uma expressão OData $filter opcional para restringir ainda mais os resultados (combinado com o IsPrivate eq false uso and). select nomes de propriedade específicos de projetos por meio de $select.

A resposta será feita BatchItemResponse.data após a execução.

list(*, filter: str | None = None, select: List[str] | None = None) -> None

Parâmetros

Nome Description
filter
Obrigatório
str ou None

Expressão OData $filter adicional.

select
Obrigatório
list[str] ou None

Lista de nomes de propriedades para $select.

Parâmetros somente de palavra-chave

Nome Description
filter
Valor padrão: None
select
Valor padrão: None

remove_columns

Adicione operações de exclusão de coluna ao lote (uma por coluna).

As tabelas MetadataId e as de cada coluna são resolvidas no momento da MetadataId execução. Cada coluna produz uma entrada em responses.

remove_columns(table: str, columns: str | List[str]) -> None

Parâmetros

Nome Description
table
Obrigatório
str

Nome do esquema da tabela de destino.

columns
Obrigatório
str ou list[str]

Nome do esquema de coluna ou lista de nomes de esquema de coluna a serem removidos.