FileOperations Classe

Namespace para operações de arquivo.

Acessado por .client.files Fornece operações de upload de arquivo para colunas de arquivo do Dataverse.

Exemplo:

   client = DataverseClient(base_url, credential)

   client.files.upload(
       "account", account_id, "new_Document", "/path/to/file.pdf"
   )

Construtor

FileOperations(client: DataverseClient)

Parâmetros

Nome	Description
client Obrigatório	DataverseClient A instância pai DataverseClient .

Métodos

upload

Carregue um arquivo em uma coluna de arquivo do Dataverse.

upload

Carregue um arquivo em uma coluna de arquivo do Dataverse.

upload(table: str, record_id: str, file_column: str, path: str, *, mode: str | None = None, mime_type: str | None = None, if_none_match: bool = True) -> None

Parâmetros

Nome	Description
table Obrigatório	str Nome do esquema da tabela (por exemplo, "account" ou "new_MyTestTable").
record_id Obrigatório	str GUID do registro de destino.
file_column Obrigatório	str Nome do esquema do atributo de coluna de arquivo (por exemplo, "new_Document"). Se a coluna não existir, ela será criada automaticamente.
path Obrigatório	str Caminho do sistema de arquivos local para o arquivo. O nome do arquivo armazenado será o nome base desse caminho.
mode Obrigatório	str Estratégia de upload: "auto" (padrão) "small"ou "chunk". O modo automático seleciona o upload pequeno ou em partes com base no tamanho do arquivo.
mime_type Obrigatório	str Tipo MIME explícito a ser armazenado com o arquivo (por exemplo "application/pdf"). Se não for fornecido, o padrão será "application/octet-stream".
if_none_match Obrigatório	bool Quando True (padrão), envia If-None-Match: null o cabeçalho para ter êxito somente se a coluna estiver vazia no momento. Defina False para sempre substituir usando If-Match: *.

Parâmetros somente de palavra-chave

Nome	Description
mode	Valor padrão: None
mime_type	Valor padrão: None
if_none_match	Valor padrão: True

Exceções

Tipo	Description
HttpError	Se o upload falhar ou a coluna de arquivo não estiver vazia quando if_none_match=True
FileNotFoundError	Se o caminho do arquivo especificado não existir.

Exemplos

Carregue um arquivo PDF:

   client.files.upload(
       "account",
       account_id,
       "new_Contract",
       "/path/to/contract.pdf",
       mime_type="application/pdf",
   )

Carregar com a seleção do modo automático:

   client.files.upload(
       "email",
       email_id,
       "new_Attachment",
       "/path/to/large_file.zip",
   )