FileOperations クラス

ファイル操作の名前空間。

client.files経由でアクセスされます。 Dataverse ファイル列のファイルアップロード操作を提供します。

例:


   client = DataverseClient(base_url, credential)

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

コンストラクター

FileOperations(client: DataverseClient)

パラメーター

名前 説明
client
必須

DataverseClient インスタンス。

メソッド

upload

Dataverse ファイル列にファイルをアップロードします。

upload

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

パラメーター

名前 説明
table
必須
str

テーブルのスキーマ名 ( "account""new_MyTestTable"など)。

record_id
必須
str

ターゲット レコードの GUID。

file_column
必須
str

ファイル列属性のスキーマ名 (例: "new_Document")。 列が存在しない場合は、自動的に作成されます。

path
必須
str

ファイルへのローカル ファイル システム パス。 保存されたファイル名は、このパスのベース名になります。

mode
必須
str

アップロード戦略: "auto" (既定)、 "small"、または "chunk"。 自動モードでは、ファイル サイズに基づいて小さいアップロードまたはチャンクアップロードが選択されます。

mime_type
必須
str

ファイルと共に格納する明示的な MIME の種類 (例: "application/pdf")。 指定しない場合、既定値は "application/octet-stream"

if_none_match
必須

True (既定値) の場合、列 If-None-Match: null 現在空の場合にのみ成功するようにヘッダーを送信します。 常に If-Match: *を使用して上書きする場合は False に設定します。

キーワードのみのパラメーター

名前 説明
mode
規定値: None
mime_type
規定値: None
if_none_match
規定値: True

例外

説明

アップロードが失敗した場合、またはファイル列が空でない場合 if_none_match=True

指定したファイル パスが存在しない場合。

PDF ファイルをアップロードします。


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

自動モード選択を使用したアップロード:


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