DataLakeFileClient class

Crea un'istanza di DataLakeFileClient dall'URL e dalla pipeline.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parametri

Crea un'istanza di DataLakeFileClient da URL e credenziali.

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

Parametri

Nome del file system corrente.

string fileSystemName

Valore della proprietà

Nome del percorso corrente (directory o file).

string name

Valore della proprietà

accountName: string

Valore della proprietà

Ereditato daDataLakePathClient.accountName

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

ereditato daDataLakePathClient.credential

Valore stringa URL codificato.

url: string

Valore della proprietà

ereditato daDataLakePathClient.url

Carica i dati da aggiungere a un file. I dati possono essere aggiunti solo a un file. Per applicare i dati caricati in modo pervioso in un file, chiamare flush.

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

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

Parametri

Restituisce

Creare un file.

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

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

Parametri

Restituisce

Creare un file.

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

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

Parametri

Restituisce

Creare un file se non esiste già.

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

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

Parametri

Restituisce

Creare un file se non esiste già.

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

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

Parametri

Restituisce

Scarica (scritture) i dati aggiunti in precedenza a un file.

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

Parametri

Restituisce

Disponibile solo per i client costruiti con credenziali di chiave condivisa.

Genera una stringa per firmare un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Disponibile solo per i client costruiti con credenziali di chiave condivisa.

Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

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

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Genera una stringa per firmare un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalla chiave di delega dell'utente di input.

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

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

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalla chiave di delega dell'utente di input.

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

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

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Query rapida per un file in formato JSON o CSV.

Esempio di utilizzo (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>

Parametri

Restituisce

Scarica un file dal servizio, inclusi i metadati e le proprietà.

• In Node.jsi dati vengono restituiti in un flusso leggibileStreamBody
• Nei browser i dati vengono restituiti in un contenuto promiseAsBlob

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

• Esempio di utilizzo (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);
  });
}

Esempio di utilizzo (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>

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Legge un file Data Lake in parallelo a un buffer. Offset e conteggio sono facoltativi, passare 0 per entrambi per leggere l'intero file.

Avviso: i buffer possono supportare solo file fino a circa un gigabyte su sistemi a 32 bit o circa due gigabyte su sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i file di dimensioni superiori a queste dimensioni, prendere in considerazione readToFile.

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

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME

Legge un file Data Lake in parallelo a un buffer. Offset e conteggio sono facoltativi, passare 0 per entrambi per leggere l'intero file

Avviso: i buffer possono supportare solo file fino a circa un gigabyte su sistemi a 32 bit o circa due gigabyte su sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i file di dimensioni superiori a queste dimensioni, prendere in considerazione readToFile.

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

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Scarica un file Data Lake in un file locale. Ha esito negativo se il percorso del file specificato viene già chiuso. Offset e conteggio sono facoltativi, passano rispettivamente 0 e non definiti per scaricare l'intero file.

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

Parametri

Restituisce

I dati di risposta per l'operazione di lettura file, ma con readableStreamBody impostato su non definito perché il relativo contenuto è già letto e scritto in un file locale nel percorso specificato.

Imposta un'ora di scadenza in un file, una volta che il file viene eliminato.

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

Parametri

Restituisce

Carica un buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView in un file.

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

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Carica un file locale in un file Data Lake.

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

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Carica un flusso leggibile Node.js in un file Data Lake. Questo metodo tenterà di creare un file, quindi avvia il caricamento di blocchi per blocco. Assicurarsi che le dimensioni potenziali del flusso non superino FILE_MAX_SIZE_BYTES e il numero potenziale di blocchi non superi BLOCK_BLOB_MAX_BLOCKS.

SUGGERIMENTI PER IL MIGLIORAMENTO DELLE PRESTAZIONI:

• L'highWaterMark del flusso di input è preferibile impostare lo stesso valore con il parametro options.chunkSize, che eviterà le operazioni Buffer.concat().

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

Parametri

Restituisce

Eliminare il percorso corrente (directory o file).

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

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

Parametri

Restituisce

ereditato daDataLakePathClient.delete

Eliminare il percorso corrente (directory o file) se esistente.

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.deleteIfExists

Restituisce true se il file Data Lake rappresentato dal client esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione perché un file esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, è possibile aggiungere nuovi file da altri client o applicazioni al termine di questa funzione.

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

Parametri

Restituisce

ereditato daDataLakePathClient.exists

Restituisce i dati di controllo di accesso per un percorso (directory di file).

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.getAccessControl

Ottenere un DataLakeLeaseClient che gestisce i lease nel percorso (directory o file).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametri

Restituisce

Ereditato daDataLakePathClient.getDataLakeLeaseClient

Restituisce tutti i metadati definiti dall'utente, le proprietà HTTP standard e le proprietà di sistema per il percorso (directory o file).

AVVISO: l'oggetto metadata restituito nella risposta avrà le relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dai metodi di DataLakeFileSystemClient che elencano i percorsi usando l'opzione includeMetadata, che manterrà la combinazione di maiuscole e minuscole originali.

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

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

Parametri

Restituisce

ereditato daDataLakePathClient.getProperties

Spostare la directory o il file all'interno dello stesso file system.

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

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

Parametri

Restituisce

ereditato daDataLakePathClient.move

Spostare la directory o il file in un altro file system.

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

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

Parametri

Restituisce

ereditato daDataLakePathClient.move

Rimuove il controllo di accesso in un percorso e in percorsi secondari.

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.removeAccessControlRecursive

Impostare i dati di controllo di accesso per un percorso (directory di file).

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.setAccessControl

Imposta il controllo di accesso in un percorso e in percorsi secondari.

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.setAccessControlRecursive

Imposta le proprietà di sistema nel percorso (directory o file).

Se non viene specificato alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate.

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.setHttpHeaders

Imposta i metadati definiti dall'utente per il percorso specificato (directory del file) come una o più coppie nome-valore.

Se non viene specificata alcuna opzione o nessun metadato definito nel parametro, i metadati del percorso verranno rimossi.

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.setMetadata

Imposta le autorizzazioni per il file in un percorso.

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.setPermissions

Convertire dataLakePathClient corrente in DataLakeDirectoryClient se il percorso corrente è una directory.

function toDirectoryClient(): DataLakeDirectoryClient

Restituisce

ereditato daDataLakePathClient.toDirectoryClient

Convertire dataLakePathClient corrente in DataLakeFileClient se il percorso corrente è un file.

function toFileClient(): DataLakeFileClient

Restituisce

Ereditato daDataLakePathClient.toFileClient

Modifica il controllo di accesso in un percorso e in percorsi secondari.

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

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

Parametri

Restituisce

Ereditato daDataLakePathClient.updateAccessControlRecursive