BatchTableOperations Classe

Operazioni sui metadati della tabella in un oggetto BatchRequest.

Rispecchia client.tables esattamente: gli stessi nomi di metodo, le stesse firme. Tutti i metodi restituiscono None; i risultati arrivano tramite BatchResult.

Note

tables.delete, tables.add_columns e tables.remove_columns

richiedere una ricerca di metadati (GET EntityDefinitions) all'indirizzo

execute tempo necessario per risolvere il MetadataId della tabella.

Questa ricerca è trasparente per il chiamante.

Note

tables.add_columns e tables.remove_columns ognuno ne produce uno

elemento batch per colonna, in modo che contribuiscano più voci a

responses.

Non creare un'istanza direttamente; usare batch.tables.

Costruttore

BatchTableOperations(batch: _BatchContext)

Parametri

Nome Descrizione
batch
Necessario

Metodi

add_columns

Aggiungere operazioni di creazione di colonne al batch (una per colonna).

La tabella viene risolta in fase di MetadataId esecuzione. Ogni colonna produce una voce in responses.

create

Aggiungere un'operazione di creazione di tabelle al batch.

Note

Il controllo di preesistenza eseguito da client.tables.create viene ignorato

in modalità batch. Se la tabella esiste già, il server restituisce un errore

nell'oggetto corrispondente BatchItemResponse.

create_lookup_field

Aggiungere una creazione di un campo di ricerca al batch (pratico wrapper per create_one_to_many_relationship).

create_many_to_many_relationship

Aggiungere una creazione di relazione molti-a-molti al batch.

create_one_to_many_relationship

Aggiungere una creazione di relazione uno-a-molti al batch.

delete

Aggiungere un'operazione di eliminazione di tabella al batch.

La tabella viene risolta tramite una richiesta GET in fase di MetadataId esecuzione.

delete_relationship

Aggiungere un'operazione di eliminazione di relazione al batch.

get

Aggiungere un'operazione table-metadata-get al batch.

La risposta sarà in dopo BatchItemResponse.data l'esecuzione.

get_relationship

Aggiungere un'operazione relationship-metadata-get al batch.

La risposta sarà in dopo BatchItemResponse.data l'esecuzione.

list

Aggiungere un'operazione list-all-tables al batch.

Esegue il mirror.client.tables.list() Fornire un'espressione OData $filter facoltativa per restringere ulteriormente i risultati (combinati con IsPrivate eq false l'uso di and). select proietta nomi di proprietà specifici tramite $select.

La risposta sarà in dopo BatchItemResponse.data l'esecuzione.

remove_columns

Aggiungere operazioni di eliminazione di colonna al batch (una per colonna).

Le tabelle MetadataId e le colonne vengono risolte in fase di MetadataId esecuzione. Ogni colonna produce una voce in responses.

add_columns

Aggiungere operazioni di creazione di colonne al batch (una per colonna).

La tabella viene risolta in fase di MetadataId esecuzione. Ogni colonna produce una voce in responses.

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

Parametri

Nome Descrizione
table
Necessario
str

Nome dello schema della tabella di destinazione.

columns
Necessario

Mapping dei nomi degli schemi di colonna alle stringhe di tipo o alle sottoclassi Enum.

create

Aggiungere un'operazione di creazione di tabelle al batch.

Note

Il controllo di preesistenza eseguito da client.tables.create viene ignorato

in modalità batch. Se la tabella esiste già, il server restituisce un errore

nell'oggetto corrispondente BatchItemResponse.

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

Parametri

Nome Descrizione
table
Necessario
str

Nome dello schema della nuova tabella , ad esempio "new_Product".

columns
Necessario

Mapping dei nomi degli schemi di colonna alle stringhe di tipo o alle sottoclassi Enum.

solution
Necessario
str oppure None

Nome univoco della soluzione facoltativo.

primary_column
Necessario
str oppure None

Nome dello schema della colonna primaria facoltativo.

display_name
Necessario
str oppure None

Nome visualizzato leggibile per la tabella. Se omesso, per impostazione predefinita viene impostato il nome dello schema della tabella.

Parametri di sole parole chiave

Nome Descrizione
solution
Valore predefinito: None
primary_column
Valore predefinito: None
display_name
Valore predefinito: None

create_lookup_field

Aggiungere una creazione di un campo di ricerca al batch (pratico wrapper per 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

Parametri

Nome Descrizione
referencing_table
Necessario
str

Nome logico della tabella figlio (molti).

lookup_field_name
Necessario
str

Nome dello schema per il campo di ricerca.

referenced_table
Necessario
str

Nome logico della tabella padre (uno).

display_name
Necessario
str oppure None

Nome visualizzato per il campo di ricerca.

description
Necessario
str oppure None

Descrizione facoltativa.

required
Necessario

Indica se la ricerca è obbligatoria.

cascade_delete
Necessario
str

Eliminare il comportamento a catena.

solution
Necessario
str oppure None

Nome univoco della soluzione facoltativo.

language_code
Necessario
int

Codice lingua per le etichette (impostazione predefinita 1033).

Parametri di sole parole chiave

Nome Descrizione
display_name
Valore predefinito: None
description
Valore predefinito: None
required
Valore predefinito: False
cascade_delete
Valore predefinito: RemoveLink
solution
Valore predefinito: None
language_code
Valore predefinito: 1033

create_many_to_many_relationship

Aggiungere una creazione di relazione molti-a-molti al batch.

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

Parametri

Nome Descrizione
relationship
Necessario

Metadati delle relazioni.

solution
Necessario
str oppure None

Nome univoco della soluzione facoltativo.

Parametri di sole parole chiave

Nome Descrizione
solution
Valore predefinito: None

create_one_to_many_relationship

Aggiungere una creazione di relazione uno-a-molti al batch.

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

Parametri

Nome Descrizione
lookup
Necessario

Metadati dell'attributo di ricerca.

relationship
Necessario

Metadati delle relazioni.

solution
Necessario
str oppure None

Nome univoco della soluzione facoltativo.

Parametri di sole parole chiave

Nome Descrizione
solution
Valore predefinito: None

delete

Aggiungere un'operazione di eliminazione di tabella al batch.

La tabella viene risolta tramite una richiesta GET in fase di MetadataId esecuzione.

delete(table: str) -> None

Parametri

Nome Descrizione
table
Necessario
str

Nome dello schema della tabella da eliminare.

delete_relationship

Aggiungere un'operazione di eliminazione di relazione al batch.

delete_relationship(relationship_id: str) -> None

Parametri

Nome Descrizione
relationship_id
Necessario
str

GUID dei metadati della relazione da eliminare.

get

Aggiungere un'operazione table-metadata-get al batch.

La risposta sarà in dopo BatchItemResponse.data l'esecuzione.

get(table: str) -> None

Parametri

Nome Descrizione
table
Necessario
str

Nome dello schema della tabella.

get_relationship

Aggiungere un'operazione relationship-metadata-get al batch.

La risposta sarà in dopo BatchItemResponse.data l'esecuzione.

get_relationship(schema_name: str) -> None

Parametri

Nome Descrizione
schema_name
Necessario
str

Nome dello schema della relazione.

list

Aggiungere un'operazione list-all-tables al batch.

Esegue il mirror.client.tables.list() Fornire un'espressione OData $filter facoltativa per restringere ulteriormente i risultati (combinati con IsPrivate eq false l'uso di and). select proietta nomi di proprietà specifici tramite $select.

La risposta sarà in dopo BatchItemResponse.data l'esecuzione.

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

Parametri

Nome Descrizione
filter
Necessario
str oppure None

Espressione OData $filter aggiuntiva.

select
Necessario
list[str] oppure None

Elenco di nomi di proprietà per $select.

Parametri di sole parole chiave

Nome Descrizione
filter
Valore predefinito: None
select
Valore predefinito: None

remove_columns

Aggiungere operazioni di eliminazione di colonna al batch (una per colonna).

Le tabelle MetadataId e le colonne vengono risolte in fase di MetadataId esecuzione. Ogni colonna produce una voce in responses.

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

Parametri

Nome Descrizione
table
Necessario
str

Nome dello schema della tabella di destinazione.

columns
Necessario
str oppure list[str]

Nome dello schema di colonna o elenco di nomi di schema di colonna da rimuovere.