DataLakeFileClient class

Crée une instance de DataLakeFileClient à partir de l’URL et du pipeline.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Paramètres

Crée une instance de DataLakeFileClient à partir de l’URL et des informations d’identification.

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

Paramètres

Nom du système de fichiers actuel.

string fileSystemName

Valeur de propriété

Nom du chemin d’accès actuel (répertoire ou fichier).

string name

Valeur de propriété

accountName: string

Valeur de propriété

héritée deDataLakePathClient.accountName

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

héritée deDataLakePathClient.credential

Valeur de chaîne d’URL encodée.

url: string

Valeur de propriété

héritée deDataLakePathClient.url

Charge les données à ajouter à un fichier. Les données ne peuvent être ajoutées qu’à un fichier. Pour appliquer des données perviousment chargées dans un fichier, appelez le vidage.

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

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

Paramètres

Retours

Créez un fichier.

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

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

Paramètres

Retours

Créez un fichier.

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

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

Paramètres

Retours

Créez un fichier s’il n’existe pas déjà.

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

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

Paramètres

Retours

Créez un fichier s’il n’existe pas déjà.

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

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

Paramètres

Retours

Vide (écrit) les données précédemment ajoutées à un fichier.

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

Paramètres

Retours

Disponible uniquement pour les clients construits avec des informations d’identification de clé partagée.

Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Disponible uniquement pour les clients construits avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

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

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée.

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

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

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée.

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

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

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Requête rapide pour un fichier au format JSON ou CSV.

Exemple d’utilisation (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>

Paramètres

Retours

Télécharge un fichier à partir du service, y compris ses métadonnées et ses propriétés.

• Dans Node.js, les données retournent dans un flux lisibleStreamBody
• Dans les navigateurs, les données retournent dans un contenu de promesseAsBlob

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

• Exemple d’utilisation (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);
  });
}

Exemple d’utilisation (navigateur) :

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Lit un fichier Data Lake en parallèle dans une mémoire tampon. Le décalage et le nombre sont facultatifs, transmettez 0 pour les deux pour lire l’intégralité du fichier.

Avertissement : les mémoires tampons peuvent uniquement prendre en charge les fichiers pouvant atteindre environ un gigaoctet sur des systèmes 32 bits ou environ deux gigaoctets sur des systèmes 64 bits en raison des limitations de Node.js/V8. Pour les fichiers supérieurs à cette taille, envisagez readToFile.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME

Lit un fichier Data Lake en parallèle dans une mémoire tampon. Offset et count sont facultatifs, passez 0 pour les deux pour lire l’intégralité du fichier

Avertissement : les mémoires tampons peuvent uniquement prendre en charge les fichiers pouvant atteindre environ un gigaoctet sur des systèmes 32 bits ou environ deux gigaoctets sur des systèmes 64 bits en raison des limitations de Node.js/V8. Pour les fichiers supérieurs à cette taille, envisagez readToFile.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Télécharge un fichier Data Lake dans un fichier local. Échoue si le chemin d’accès du fichier donné se ferme déjà. Le décalage et le nombre sont facultatifs, passent respectivement 0 et non définis pour télécharger l’intégralité du fichier.

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

Paramètres

Retours

Données de réponse pour l’opération de lecture de fichier, mais avec readableStreamBody défini sur non défini, car son contenu est déjà lu et écrit dans un fichier local au chemin spécifié.

Définit une heure d’expiration sur un fichier, une fois cette heure remplie, le fichier est supprimé.

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

Paramètres

Retours

Charge une mémoire tampon(Node.js)/Blob/ArrayBuffer/ArrayBufferView dans un fichier.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Charge un fichier local dans un fichier Data Lake.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Charge un flux Node.js lisible dans un fichier Data Lake. Cette méthode tente de créer un fichier, puis commence à charger un bloc par segment. Assurez-vous que la taille potentielle du flux ne dépasse pas FILE_MAX_SIZE_BYTES et que le nombre potentiel de blocs ne dépasse pas BLOCK_BLOB_MAX_BLOCKS.

CONSEILS D’AMÉLIORATION DES PERFORMANCES :

• Le flux d’entrée highWaterMark est préférable de définir une même valeur avec le paramètre options.chunkSize, ce qui évite les opérations Buffer.concat().

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

Paramètres

Retours

Supprimez le chemin actuel (répertoire ou fichier).

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

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

Paramètres

Retours

héritée deDataLakePathClient.delete

Supprimez le chemin actuel (répertoire ou fichier) s’il existe.

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

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

Paramètres

Retours

héritée deDataLakePathClient.deleteIfExists

Retourne true si le fichier Data Lake représenté par ce client existe ; false sinon.

REMARQUE : utilisez cette fonction avec soin, car un fichier existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux fichiers peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée.

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

Paramètres

Retours

héritée deDataLakePathClient.exists

Retourne les données de contrôle d’accès pour un chemin d’accès (répertoire de fichier).

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

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

Paramètres

Retours

héritée deDataLakePathClient.getAccessControl

Obtenez un DataLakeLeaseClient qui gère les baux sur le chemin d’accès (répertoire ou fichier).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Paramètres

Retours

héritée deDataLakePathClient.getDataLakeLeaseClient

Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du chemin d’accès (répertoire ou fichier).

AVERTISSEMENT : l’objet metadata retourné dans la réponse aura ses clés en minuscules, même s’ils contenaient initialement des caractères majuscules. Cela diffère des clés de métadonnées retournées par les méthodes de DataLakeFileSystemClient qui répertorient les chemins d’accès à l’aide de l’option includeMetadata, qui conserve leur casse d’origine.

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

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

Paramètres

Retours

héritée deDataLakePathClient.getProperties

Déplacer le répertoire ou le fichier dans le même système de fichiers.

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

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

Paramètres

Retours

héritée deDataLakePathClient.move

Déplacez le répertoire ou le fichier vers un autre système de fichiers.

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

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

Paramètres

Retours

héritée deDataLakePathClient.move

Supprime le contrôle d’accès sur un chemin d’accès et un sous-chemin d’accès.

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

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

Paramètres

Retours

héritée deDataLakePathClient.removeAccessControlRecursive

Définissez les données de contrôle d’accès pour un chemin d’accès (répertoire de fichier).

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

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

Paramètres

Retours

héritée deDataLakePathClient.setAccessControl

Définit le contrôle d’accès sur un chemin d’accès et des sous-chemins.

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

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

Paramètres

Retours

héritée deDataLakePathClient.setAccessControlRecursive

Définit les propriétés système sur le chemin d’accès (répertoire ou fichier).

Si aucune valeur n’est fournie ou aucune valeur fournie pour les en-têtes HTTP d’objet blob spécifiés, ces en-têtes HTTP d’objet blob sans valeur seront effacés.

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

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

Paramètres

Retours

héritée deDataLakePathClient.setHttpHeaders

Définit les métadonnées définies par l’utilisateur pour le chemin d’accès spécifié (répertoire de fichier) sous la forme d’une ou plusieurs paires nom-valeur.

Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre, les métadonnées de chemin d’accès sont supprimées.

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

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

Paramètres

Retours

héritée deDataLakePathClient.setMetadata

Définit les autorisations de fichier sur un chemin d’accès.

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

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

Paramètres

Retours

héritée deDataLakePathClient.setPermissions

Convertissez dataLakePathClient actuel en DataLakeDirectoryClient si le chemin actuel est un répertoire.

function toDirectoryClient(): DataLakeDirectoryClient

Retours

héritée deDataLakePathClient.toDirectoryClient

Convertissez dataLakePathClient actuel en DataLakeFileClient si le chemin actuel est un fichier.

function toFileClient(): DataLakeFileClient

Retours

héritée deDataLakePathClient.toFileClient

Modifie le contrôle d’accès sur un chemin d’accès et des sous-chemins.

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

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

Paramètres

Retours

héritée deDataLakePathClient.updateAccessControlRecursive