FileOperations Klasse

Namespace für Dateivorgänge.

Zugriff über client.files. Stellt Dateiuploadvorgänge für Dataverse-Dateispalten bereit.

Beispiel:


   client = DataverseClient(base_url, credential)

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

Konstruktor

FileOperations(client: DataverseClient)

Parameter

Name Beschreibung
client
Erforderlich

Die übergeordnete DataverseClient Instanz.

Methoden

upload

Laden Sie eine Datei in eine Dataverse-Dateispalte hoch.

upload

Laden Sie eine Datei in eine Dataverse-Dateispalte hoch.

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

Parameter

Name Beschreibung
table
Erforderlich
str

Schemaname der Tabelle (z. B. "account" oder "new_MyTestTable").

record_id
Erforderlich
str

GUID des Zieldatensatzes.

file_column
Erforderlich
str

Schemaname des Dateispalten-Attributs (z. B. "new_Document"). Wenn die Spalte nicht vorhanden ist, wird sie automatisch erstellt.

path
Erforderlich
str

Lokaler Dateisystempfad zur Datei. Der gespeicherte Dateiname ist der Basisname dieses Pfads.

mode
Erforderlich
str

Uploadstrategie: "auto" (Standard), "small"oder "chunk". Der automatische Modus wählt den kleinen oder geblockten Upload basierend auf der Dateigröße aus.

mime_type
Erforderlich
str

Expliziter MIME-Typ, der mit der Datei gespeichert werden soll (z. B. "application/pdf"). Wenn nicht angegeben, wird standardmäßig auf "application/octet-stream".

if_none_match
Erforderlich

Wenn True (Standard) ist, wird If-None-Match: null die Kopfzeile nur erfolgreich gesendet, wenn die Spalte zurzeit leer ist. Legen Sie False fest, um immer mit "Überschreiben" If-Match: *zu überschreiben.

Nur Schlüsselwortparameter

Name Beschreibung
mode
Standardwert: None
mime_type
Standardwert: None
if_none_match
Standardwert: True

Ausnahmen

Typ Beschreibung

Wenn der Upload fehlschlägt oder die Dateispalte nicht leer ist, wenn if_none_match=True

Wenn der angegebene Dateipfad nicht vorhanden ist.

Beispiele

Hochladen einer PDF-Datei:


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

Hochladen mit Auswahl des automatischen Modus:


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