FileOperations Classe

Espace de noms pour les opérations de fichier.

Accessible via client.files. Fournit des opérations de chargement de fichiers pour les colonnes de fichier Dataverse.

Exemple :


   client = DataverseClient(base_url, credential)

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

Constructeur

FileOperations(client: DataverseClient)

Paramètres

Nom	Description
client Obligatoire	DataverseClient Instance parente DataverseClient .

Méthodes

upload

Chargez un fichier dans une colonne de fichier Dataverse.

upload

Chargez un fichier dans une colonne de fichier 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

Paramètres

Nom	Description
table Obligatoire	str Nom du schéma de la table (par exemple `"account"` , ou `"new_MyTestTable"`).
record_id Obligatoire	str GUID de l’enregistrement cible.
file_column Obligatoire	str Nom du schéma de l’attribut de colonne de fichier (par exemple, `"new_Document"`). Si la colonne n’existe pas, elle est créée automatiquement.
path Obligatoire	str Chemin du système de fichiers local vers le fichier. Le nom de fichier stocké est le nom de base de ce chemin d’accès.
mode Obligatoire	str Stratégie de chargement : `"auto"` (par défaut), `"small"`ou `"chunk"`. Le mode automatique sélectionne un chargement petit ou segmenté en fonction de la taille du fichier.
mime_type Obligatoire	str Type MIME explicite à stocker avec le fichier (par exemple `"application/pdf"`). S’il n’est pas fourni, la valeur par défaut est `"application/octet-stream"`.
if_none_match Obligatoire	bool Lorsque la valeur est True (valeur par défaut), envoie l’en-tête `If-None-Match: null` pour réussir uniquement si la colonne est actuellement vide. Définissez False sur toujours remplacer à l’aide `If-Match: *`de .

Paramètres de mot clé uniquement

Nom	Description
mode	Valeur par défaut: None
mime_type	Valeur par défaut: None
if_none_match	Valeur par défaut: True

Exceptions

Type	Description
HttpError	Si le chargement échoue ou si la colonne de fichier n’est pas vide quand `if_none_match=True`
FileNotFoundError	Si le chemin d’accès au fichier spécifié n’existe pas.

Exemples

Chargez un fichier PDF :


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

Charger avec la sélection en mode automatique :


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