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 から継承された

ファイルに追加するデータをアップロードします。 データはファイルにのみ追加できます。 頻繁にアップロードされたデータをファイルに適用するには、フラッシュを呼び出します。

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>

パラメーター

戻り値

共有キー資格情報を使用して構築されたクライアントでのみ使用できます。

渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI に署名する文字列を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

パラメーター

戻り値

このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。

共有キー資格情報を使用して構築されたクライアントでのみ使用できます。

渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください

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

パラメーター

戻り値

このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。

渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (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 トークンで構成される SAS URI。

渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (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 トークンで構成される SAS URI。

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 ビット システムでは最大約 1 ギガバイト、64 ビット システムでは約 2 ギガバイトです。Node.js/V8 の制限があるためです。 このサイズより大きいファイルの場合は、readToFile検討してください。

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

パラメーター

戻り値

NODE.JSランタイムでのみ使用できます

バッファーに並列で Data Lake ファイルを読み取ります。 オフセットとカウントは省略可能で、両方に 0 を渡してファイル全体を読み取る

警告: バッファーでサポートできるファイルは、32 ビット システムでは最大約 1 ギガバイト、64 ビット システムでは約 2 ギガバイトです。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 の内容は既に読み取られ、指定されたパスのローカル ファイルに書き込まれるため、undefined に設定されています。

ファイルの有効期限を設定します。その時刻が満たされると、ファイルは削除されます。

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

パラメーター

戻り値

Buffer(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 は、buffer.concat() 操作を回避する options.chunkSize パラメーターを使用して同じ値を設定することをお勧めします。

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 オブジェクトのキーは、最初に大文字が含まれていた場合でも小文字になります。 これは、 オプションを使用してパスを一覧表示する 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から継承された

指定したパス (ファイルのディレクトリ) のユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。

オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、パス メタデータが削除されます。

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 から継承された