FileOperations Classe

Spazio dei nomi per le operazioni di file.

Accesso tramite client.files. Fornisce operazioni di caricamento file per le colonne di file di Dataverse.

Esempio:


   client = DataverseClient(base_url, credential)

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

Costruttore

FileOperations(client: DataverseClient)

Parametri

Nome Descrizione
client
Necessario

Istanza padre DataverseClient .

Metodi

upload

Caricare un file in una colonna di file Dataverse.

upload

Caricare un file in una colonna di file 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

Parametri

Nome Descrizione
table
Necessario
str

Nome dello schema della tabella ,ad esempio "account" o "new_MyTestTable".

record_id
Necessario
str

GUID del record di destinazione.

file_column
Necessario
str

Nome dello schema dell'attributo della colonna di file (ad esempio, "new_Document"). Se la colonna non esiste, verrà creata automaticamente.

path
Necessario
str

Percorso del file system locale al file. Il nome file archiviato sarà il nome di base di questo percorso.

mode
Necessario
str

Strategia di caricamento: "auto" (impostazione predefinita), "small"o "chunk". La modalità automatica seleziona il caricamento ridotto o in blocchi in base alle dimensioni del file.

mime_type
Necessario
str

Tipo MIME esplicito da archiviare con il file , ad esempio "application/pdf". Se non specificato, il valore predefinito è "application/octet-stream".

if_none_match
Necessario

Se True (impostazione predefinita), invia If-None-Match: null l'intestazione solo se la colonna è attualmente vuota. Impostare False per sovrascrivere sempre usando If-Match: *.

Parametri di sole parole chiave

Nome Descrizione
mode
Valore predefinito: None
mime_type
Valore predefinito: None
if_none_match
Valore predefinito: True

Eccezioni

Tipo Descrizione

Se il caricamento non riesce o la colonna del file non è vuota quando if_none_match=True

Se il percorso del file specificato non esiste.

Esempio

Caricare un file PDF:


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

Carica con la selezione della modalità automatica:


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