FileOperations Clase

Espacio de nombres para las operaciones de archivo.

Acceso a través de client.files. Proporciona operaciones de carga de archivos para columnas de archivo de Dataverse.

Ejemplo:

   client = DataverseClient(base_url, credential)

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

Constructor

FileOperations(client: DataverseClient)

Parámetros

Nombre	Description
client Requerido	DataverseClient Instancia primaria DataverseClient .

Métodos

upload

Cargue un archivo en una columna de archivo de Dataverse.

upload

Cargue un archivo en una columna de archivo de 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

Nombre	Description
table Requerido	str Nombre de esquema de la tabla (por ejemplo "account" , o "new_MyTestTable").
record_id Requerido	str GUID del registro de destino.
file_column Requerido	str Nombre de esquema del atributo de columna de archivo (por ejemplo, "new_Document"). Si la columna no existe, se creará automáticamente.
path Requerido	str Ruta de acceso del sistema de archivos local al archivo. El nombre de archivo almacenado será el nombre base de esta ruta de acceso.
mode Requerido	str Estrategia de carga: "auto" (valor predeterminado), "small"o "chunk". El modo automático selecciona la carga pequeña o fragmentada en función del tamaño del archivo.
mime_type Requerido	str Tipo MIME explícito que se va a almacenar con el archivo (por ejemplo, "application/pdf"). Si no se proporciona, el valor predeterminado es "application/octet-stream".
if_none_match Requerido	bool Cuando es True (valor predeterminado), envía If-None-Match: null el encabezado para que solo se realice correctamente si la columna está vacía actualmente. Establezca False para sobrescribir siempre mediante If-Match: *.

Parámetros de palabra clave únicamente

Nombre	Description
mode	Valor predeterminado: None
mime_type	Valor predeterminado: None
if_none_match	Valor predeterminado: True

Excepciones

Tipo	Description
HttpError	Si se produce un error en la carga o la columna de archivo no está vacía cuando if_none_match=True
FileNotFoundError	Si la ruta de acceso del archivo especificada no existe.

Ejemplos

Cargue un archivo PDF:

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

Cargar con la selección del modo automático:

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