DataLakeFileClient class

從 URL 和管線建立 DataLakeFileClient 的實例。

new DataLakeFileClient(url: string, pipeline: Pipeline)

參數

從 URL 和認證建立 DataLakeFileClient 的實例。

new DataLakeFileClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

參數

目前檔案系統的名稱。

string fileSystemName

屬性值

目前路徑的名稱（目錄或檔案）。

string name

屬性值

accountName: string

屬性值

繼承自DataLakePathClient.accountName

例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自 @azure/identity 套件的認證，以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定，則會使用 AnonymousCredential。

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

屬性值

繼承自DataLakePathClient.credential

編碼的 URL 字串值。

url: string

屬性值

繼承自DataLakePathClient.url

上傳要附加至檔案的數據。 數據只能附加至檔案。 若要將永久上傳的數據套用至檔案，請呼叫 flush。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function append(body: RequestBodyType, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>

參數

傳回

建立檔案。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(options?: FileCreateOptions): Promise<FileCreateResponse>

參數

傳回

建立檔案。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

參數

傳回

如果檔案不存在，請建立檔案。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: FileCreateIfNotExistsOptions): Promise<FileCreateIfNotExistsResponse>

參數

傳回

如果檔案不存在，請建立檔案。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

參數

傳回

排清先前附加的數據至檔案。

function flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>

參數

傳回

僅適用於使用共用金鑰認證建構的用戶端。

根據傳入的用戶端屬性和參數，產生字串以簽署服務共用存取簽章 （SAS） URI。 SAS 是由客戶端的共用金鑰認證所簽署。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

參數

傳回

由此用戶端所代表資源的 URI 所組成的 SAS URI，後面接著產生的 SAS 令牌。

僅適用於使用共用金鑰認證建構的用戶端。

根據傳入的用戶端屬性和參數，產生服務共用存取簽章 （SAS） URI。 SAS 是由客戶端的共用金鑰認證所簽署。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): Promise<string>

參數

傳回

由此用戶端所代表資源的 URI 所組成的 SAS URI，後面接著產生的 SAS 令牌。

根據傳入的用戶端屬性和參數，產生字串以簽署服務共用存取簽章 （SAS） URI。 SAS 是由輸入使用者委派密鑰所簽署。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

參數

傳回

由此用戶端所代表資源的 URI 所組成的 SAS URI，後面接著產生的 SAS 令牌。

根據傳入的用戶端屬性和參數，產生服務共用存取簽章 （SAS） URI。 SAS 是由輸入使用者委派密鑰所簽署。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

參數

傳回

由此用戶端所代表資源的 URI 所組成的 SAS URI，後面接著產生的 SAS 令牌。

JSON 或 CSV 格式檔案的快速查詢。

範例使用方式 （Node.js）：

// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString();
console.log("Query file content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: FileQueryOptions): Promise<FileReadResponse>

參數

傳回

從服務下載檔案，包括其元數據和屬性。

• 在 Node.js中，數據會在可讀取數據流中傳回 readableStreamBody
• 在瀏覽器中，數據會在 Promise contentAsBlob 中傳回

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

• 範例使用方式 （Node.js）：

// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
console.log("Downloaded file content:", downloaded.toString());

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

範例使用方式（瀏覽器）：

// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await blobToString(await downloadResponse.contentAsBlob);
console.log("Downloaded file content", downloaded);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

function read(offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

參數

傳回

僅適用於運行時間NODE.JS。

平行讀取 Data Lake 檔案至緩衝區。 位移和計數是選擇性的，兩者都傳遞 0 以讀取整個檔案。

警告：緩衝區只能在32位系統上支援最多一 GB 的檔案，或64位系統上最多支援大約2 GB的檔案，因為 Node.js/V8的限制。 對於大於此大小的檔案，請考慮 readToFile。

function readToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

參數

傳回

僅適用於運行時間NODE.JS

平行讀取 Data Lake 檔案至緩衝區。 位移和計數是選擇性的，兩者都傳遞 0 以讀取整個檔案

警告：緩衝區只能在32位系統上支援最多一 GB 的檔案，或64位系統上最多支援大約2 GB的檔案，因為 Node.js/V8的限制。 對於大於此大小的檔案，請考慮 readToFile。

function readToBuffer(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

參數

傳回

僅適用於運行時間NODE.JS。

將 Data Lake 檔案下載到本機檔案。 如果指定的檔案路徑已經結束，就會失敗。 位移和計數是選擇性的，分別傳遞 0 和未定義，以下載整個檔案。

function readToFile(filePath: string, offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

參數

傳回

檔案讀取作業的響應數據，但已將 readableStreamBody 設定為未定義，因為其內容已經讀取並寫入指定路徑的本機檔案。

設定檔案的到期時間，一旦符合該時間，檔案就會被刪除。

function setExpiry(mode: FileExpiryMode, options?: FileSetExpiryOptions): Promise<FileSetExpiryResponse>

參數

傳回

將緩衝區（Node.js）/Blob/ArrayBuffer/ArrayBufferView 上傳至檔案。

function upload(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

參數

傳回

僅適用於運行時間NODE.JS。

將本機檔案上傳至 Data Lake 檔案。

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

參數

傳回

僅適用於運行時間NODE.JS。

將 Node.js 可讀取數據流上傳至 Data Lake 檔案。 此方法會嘗試建立檔案，然後依區塊開始上傳區塊。 請確定數據流的潛在大小不會超過FILE_MAX_SIZE_BYTES，而區塊數目可能不會超過BLOCK_BLOB_MAX_BLOCKS。

效能改進秘訣：

• 輸入數據流 highWaterMark 最好使用 options.chunkSize 參數設定相同的值，以避免 Buffer.concat（） 作業。

function uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

參數

傳回

刪除目前的路徑（目錄或檔案）。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

參數

傳回

繼承自DataLakePathClient.delete

如果存在，請刪除目前的路徑（目錄或檔案）。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

參數

傳回

繼承自DataLakePathClient.deleteIfExists

如果此用戶端所代表的 Data Lake 檔案存在，則傳回 true;否則為 false。

注意：請小心使用此函式，因為其他用戶端或應用程式可能會刪除現有的檔案。 反之亦然，此函式完成之後，其他用戶端或應用程式可能會新增新的檔案。

function exists(options?: PathExistsOptions): Promise<boolean>

參數

傳回

繼承自DataLakePathClient.exists

傳回路徑的訪問控制數據（檔案目錄）。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

參數

傳回

繼承自DataLakePathClient.getAccessControl

取得管理路徑 （目錄或檔案） 租用的 DataLakeLeaseClient。

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

參數

傳回

繼承自DataLakePathClient.getDataLakeLeaseClient

傳回路徑 （目錄或檔案） 的所有使用者定義元數據、標準 HTTP 屬性和系統屬性。

警告：回應中傳回的 metadata 物件會以小寫表示，即使它們原本包含大寫字元也一樣。 這與 dataLakeFileSystemClient 方法所傳回的元數據索引鍵不同， 使用 includeMetadata 選項列出路徑，這會保留其原始大小寫。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

參數

傳回

繼承自DataLakePathClient.getProperties

在相同的檔案系統內移動目錄或檔案。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

參數

傳回

繼承自DataLakePathClient.move

將目錄或檔案移至另一個檔案系統。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

參數

傳回

繼承自DataLakePathClient.move

拿掉路徑和子路徑上的訪問控制。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

參數

傳回

繼承自DataLakePathClient.removeAccessControlRecursive

設定路徑的訪問控制數據（檔案目錄）。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

參數

傳回

繼承自DataLakePathClient.setAccessControl

設定路徑和子路徑上的訪問控制。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

參數

傳回

繼承自DataLakePathClient.setAccessControlRecursive

在路徑上設定系統屬性（目錄或檔案）。

如果未提供任何值，或未為指定的 Blob HTTP 標頭提供任何值，則會清除沒有值的這些 Blob HTTP 標頭。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

參數

傳回

繼承自DataLakePathClient.setHttpHeaders

將指定路徑的使用者定義元資料（檔案目錄）設定為一或多個名稱/值組。

如果未提供任何選項，或參數中未定義任何元數據，則會移除路徑元數據。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

參數

傳回

繼承自DataLakePathClient.setMetadata

設定路徑上的檔案許可權。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

參數

傳回

繼承自DataLakePathClient.setPermissions

如果目前的路徑是目錄，請將目前的 DataLakePathClient 轉換為 DataLakeDirectoryClient。

function toDirectoryClient(): DataLakeDirectoryClient

傳回

繼承自DataLakePathClient.toDirectoryClient

如果目前的路徑是檔案，請將目前的 DataLakePathClient 轉換為 DataLakeFileClient。

function toFileClient(): DataLakeFileClient

傳回

繼承自DataLakePathClient.toFileClient

修改路徑和子路徑上的訪問控制。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

參數

傳回

繼承自DataLakePathClient.updateAccessControlRecursive