DataLakeFileClient class

Erstellt eine Instanz von DataLakeFileClient aus url und Pipeline.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parameter

Erstellt eine Instanz von DataLakeFileClient aus URL und Anmeldeinformationen.

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

Parameter

Name des aktuellen Dateisystems.

string fileSystemName

Eigenschaftswert

Name des aktuellen Pfads (Verzeichnis oder Datei).

string name

Eigenschaftswert

accountName: string

Eigenschaftswert

geerbt vonDataLakePathClient.accountName

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

vonDataLakePathClient.credential

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

vonDataLakePathClient.url geerbt

Lädt Daten hoch, die an eine Datei angefügt werden sollen. Daten können nur an eine Datei angefügt werden. Rufen Sie die Löschung auf, um pervious hochgeladene Daten auf eine Datei anzuwenden.

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

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

Parameter

Gibt zurück

Erstellen Sie eine Datei.

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

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

Parameter

Gibt zurück

Erstellen Sie eine Datei.

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

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

Parameter

Gibt zurück

Erstellen Sie eine Datei, wenn sie noch nicht vorhanden ist.

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

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

Parameter

Gibt zurück

Erstellen Sie eine Datei, wenn sie noch nicht vorhanden ist.

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

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

Parameter

Gibt zurück

Leerungen (Schreibvorgänge) zuvor angefügte Daten an eine Datei.

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

Parameter

Gibt zurück

Nur für Clients verfügbar, die mit freigegebenen Schlüsselanmeldeinformationen erstellt wurden.

Generiert Zeichenfolge zum Signieren für einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parameter

Gibt zurück

Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

Nur für Clients verfügbar, die mit freigegebenen Schlüsselanmeldeinformationen erstellt wurden.

Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

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

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

Parameter

Gibt zurück

Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

Generiert Zeichenfolge zum Signieren für einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird vom Eingabebenutzerdelegierungsschlüssel signiert.

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

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

Parameter

Gibt zurück

Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird vom Eingabebenutzerdelegierungsschlüssel signiert.

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

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

Parameter

Gibt zurück

Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

Schnelle Abfrage für eine JSON- oder CSV-formatierte Datei.

Beispielverwendung (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>

Parameter

Gibt zurück

Lädt eine Datei aus dem Dienst herunter, einschließlich der Metadaten und Eigenschaften.

• In Node.jswerden Daten in einem lesbaren Stream lesbarStreamBody zurückgegeben.
• In Browsern werden Daten in einem ZusageinhaltAsBlob zurückgegeben.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

• Beispielverwendung (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);
  });
}

Beispielverwendung (Browser):

// 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>

Parameter

Gibt zurück

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Liest eine Data Lake-Datei parallel zu einem Puffer. Offset und Anzahl sind optional, übergeben 0, um die gesamte Datei zu lesen.

Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Dateien, die größer als diese Größe sind, readToFile-.

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

Parameter

Gibt zurück

NUR IN NODE.JS RUNTIME VERFÜGBAR

Liest eine Data Lake-Datei parallel zu einem Puffer. Offset und Anzahl sind optional, übergeben 0, um die gesamte Datei zu lesen.

Warnung: Puffer können Dateien nur bis zu einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen, da einschränkungen von Node.js/V8. Berücksichtigen Sie für Dateien, die größer als diese Größe sind, readToFile-.

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

Parameter

Gibt zurück

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt eine Data Lake-Datei in eine lokale Datei herunter. Schlägt fehl, wenn der angegebene Dateipfad bereits beendet wird. Offset und Anzahl sind optional, übergeben 0 und nicht definiert, um die gesamte Datei herunterzuladen.

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

Parameter

Gibt zurück

Die Antwortdaten für den Dateilesevorgang, aber mit "readStreamBody" auf "undefiniert", da der Inhalt bereits in eine lokale Datei im angegebenen Pfad gelesen und geschrieben wurde.

Legt eine Ablaufzeit für eine Datei fest, sobald diese Zeit erfüllt ist, wird die Datei gelöscht.

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

Parameter

Gibt zurück

Lädt einen Puffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView in eine Datei hoch.

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

Parameter

Gibt zurück

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt eine lokale Datei in eine Data Lake-Datei hoch.

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

Parameter

Gibt zurück

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt einen Node.js lesbaren Datenstrom in eine Data Lake-Datei hoch. Diese Methode versucht, eine Datei zu erstellen, und beginnt dann mit dem Hochladen von Block nach Block. Stellen Sie sicher, dass die potenzielle Größe des Datenstroms FILE_MAX_SIZE_BYTES nicht überschreitet, und die potenzielle Anzahl von Datenblöcken überschreitet nicht BLOCK_BLOB_MAX_BLOCKS.

TIPPS ZUR LEISTUNGSVERBESSERUNG:

• Input stream highWaterMark is better to set a same value with options.chunkSize parameter, which will avoid Buffer.concat() operations.

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

Parameter

Gibt zurück

Aktuellen Pfad löschen (Verzeichnis oder Datei).

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

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

Parameter

Gibt zurück

vonDataLakePathClient.delete geerbt

Löschen Sie den aktuellen Pfad (Verzeichnis oder Datei), falls vorhanden.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.deleteIfExists

Gibt true zurück, wenn die Data Lake-Datei, die durch diesen Client dargestellt wird, vorhanden ist; andernfalls "false".

HINWEIS: Verwenden Sie diese Funktion sorgfältig, da eine vorhandene Datei möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Dateien von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen wurde.

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

Parameter

Gibt zurück

VonDataLakePathClient geerbt.exists

Gibt die Zugriffssteuerungsdaten für einen Pfad (Verzeichnis der Datei) zurück.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.getAccessControl-

Rufen Sie eine DataLakeLeaseClient- ab, die Leases für den Pfad (Verzeichnis oder Datei) verwaltet.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameter

Gibt zurück

Geerbt vonDataLakePathClient.getDataLakeLeaseClient

Gibt alle benutzerdefinierten Metadaten, Standard-HTTP-Eigenschaften und Systemeigenschaften für den Pfad (Verzeichnis oder Datei) zurück.

WARNUNG: Das in der Antwort zurückgegebene metadata-Objekt weist die Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von den Methoden von DataLakeFileSystemClient, die Pfade mithilfe der Option includeMetadata auflisten, die ihre ursprüngliche Groß-/Kleinschreibung beibehalten.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.getProperties

Verschieben sie das Verzeichnis oder die Datei innerhalb desselben Dateisystems.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.move

Verschieben sie das Verzeichnis oder die Datei in ein anderes Dateisystem.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.move

Entfernt die Zugriffssteuerung für einen Pfad und Unterpfad.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.removeAccessControlRecursive

Legen Sie die Zugriffssteuerungsdaten für einen Pfad (Verzeichnis der Datei) fest.

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

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

Parameter

Gibt zurück

Geerbt vonDataLakePathClient.setAccessControl

Legt die Zugriffssteuerung für einen Pfad und Unterpfad fest.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.setAccessControlRecursive

Legt Systemeigenschaften für den Pfad (Verzeichnis oder Datei) fest.

Wenn kein Wert angegeben oder kein Wert für die angegebenen BLOB-HTTP-Header bereitgestellt wird, werden diese BLOB-HTTP-Header ohne einen Wert gelöscht.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.setHttpHeaders

Legt benutzerdefinierte Metadaten für den angegebenen Pfad (Verzeichnis der Datei) als ein oder mehrere Name-Wert-Paare fest.

Wenn im Parameter keine Option angegeben oder keine Metadaten definiert sind, werden die Pfadmetadaten entfernt.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.setMetadata-

Legt die Dateiberechtigungen für einen Pfad fest.

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

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.setPermissions-

Konvertieren Sie den aktuellen DataLakePathClient in DataLakeDirectoryClient, wenn der aktuelle Pfad ein Verzeichnis ist.

function toDirectoryClient(): DataLakeDirectoryClient

Gibt zurück

geerbt vonDataLakePathClient.toDirectoryClient

Konvertieren Sie den aktuellen DataLakePathClient in DataLakeFileClient, wenn der aktuelle Pfad eine Datei ist.

function toFileClient(): DataLakeFileClient

Gibt zurück

geerbt vonDataLakePathClient.toFileClient-

Ändert die Zugriffssteuerung für einen Pfad und Unterpfad.

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

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

Parameter

Gibt zurück

vonDataLakePathClient.updateAccessControlRecursive