DataLakeFileClient class
A DataLakeFileClient az Azure Storage-fájl URL-címét jelöli.
- Extends
Konstruktorok
| Data |
Létrehoz egy DataLakeFileClient-példányt az URL-címből és a folyamatból. |
| Data |
Létrehoz egy DataLakeFileClient-példányt az URL-címből és a hitelesítő adatokból. |
Tulajdonságok
| file |
Az aktuális fájlrendszer neve. |
| name | Az aktuális elérési út neve (könyvtár vagy fájl). |
Örökölt tulajdonságok
| account |
|
| credential | Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a |
| url | Kódolt URL-sztringérték. |
Metódusok
| append(Request |
Feltölti a fájlhoz fűzendő adatokat. Az adatok csak fájlhoz fűzhetők. Ha perverz módon feltöltött adatokat szeretne alkalmazni egy fájlra, hívja meg a flush billentyűt. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| create(File |
Hozzon létre egy fájlt. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| create(Path |
Hozzon létre egy fájlt. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| create |
Hozzon létre egy fájlt, ha még nem létezik. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| create |
Hozzon létre egy fájlt, ha még nem létezik. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| flush(number, File |
Kiüríti (írja) a korábban hozzáfűzött adatokat egy fájlba. |
| generate |
Csak megosztott kulcsú hitelesítő adatokkal létrehozott ügyfelek számára érhető el. Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| generate |
Csak megosztott kulcsú hitelesítő adatokkal létrehozott ügyfelek számára érhető el. Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| generate |
Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| generate |
Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| query(string, File |
JSON- vagy CSV-formátumú fájlok gyors lekérdezése. Példahasználat (Node.js):
|
| read(number, number, File |
Letölt egy fájlt a szolgáltatásból, beleértve annak metaadatait és tulajdonságait.
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob
Példa a használatra (böngésző):
|
| read |
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Data Lake-fájlt egy pufferrel párhuzamosan olvas be. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl olvasásához mindkettőnek 0-t kell megadnia. Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Ennél nagyobb fájlok esetén fontolja meg readToFile. |
| read |
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL Egy Data Lake-fájlt egy pufferrel párhuzamosan olvas be. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl olvasásához mindkettőnek 0-t kell megadnia Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Ennél nagyobb fájlok esetén fontolja meg readToFile. |
| read |
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Letölt egy Data Lake-fájlt egy helyi fájlba. Sikertelen, ha a megadott fájl elérési útja már kilép. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl letöltéséhez adja meg a 0- és a nem definiált értékeket. |
| set |
Beállítja a fájl lejárati idejét, miután ez az idő teljesült, a fájl törlődik. |
| upload(Blob | Array |
Feltölt egy puffert(Node.js)/Blob/ArrayBuffer/ArrayBufferView fájlt egy fájlba. |
| upload |
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Feltölt egy helyi fájlt egy Data Lake-fájlba. |
| upload |
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Node.js olvasható streamet tölt fel egy Data Lake-fájlba. Ez a metódus megpróbál létrehozni egy fájlt, majd megkezdi az adattömb feltöltését adattömb alapján. Győződjön meg arról, hogy a stream lehetséges mérete nem haladja meg a FILE_MAX_SIZE_BYTES és az adattömbök lehetséges száma nem haladja meg a BLOCK_BLOB_MAX_BLOCKS. TELJESÍTMÉNYJAVÍTÁSI TIPPEK:
|
Örökölt metódusok
| delete(boolean, Path |
Az aktuális elérési út (könyvtár vagy fájl) törlése. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Ha létezik, törölje az aktuális elérési utat (könyvtárat vagy fájlt). Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
Igaz értéket ad vissza, ha az ügyfél által képviselt Data Lake-fájl létezik; máskülönben hamis. MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő fájlt más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy a függvény befejezése után más ügyfelek vagy alkalmazások új fájlokat adnak hozzá. |
| get |
Egy elérési út (fájlkönyvtár) hozzáférés-vezérlési adatait adja vissza. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Szerezze be DataLakeLeaseClient, amely az elérési úton (könyvtárban vagy fájlban) lévő bérleteket kezeli. |
| get |
A felhasználó által definiált metaadatokat, a szabványos HTTP-tulajdonságokat és az elérési út (könyvtár vagy fájl) rendszertulajdonságait adja vissza. FIGYELMEZTETÉS: A válaszban visszaadott Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-properties |
| move(string, Path |
Könyvtár vagy fájl áthelyezése ugyanabban a fájlrendszerben. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| move(string, string, Path |
Könyvtár vagy fájl áthelyezése másik fájlrendszerbe. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Eltávolítja a hozzáférés-vezérlést egy elérési úton és az alútvonalakon. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Adja meg az elérési út (fájlkönyvtár) hozzáférés-vezérlési adatait. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Beállítja a hozzáférés-vezérlést egy elérési útvonalon és alútvonalakon. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Beállítja a rendszertulajdonságokat az elérési úton (könyvtárban vagy fájlban). Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejlécekhez, a blob HTTP-fejlécei érték nélkül törlődnek. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties |
| set |
A megadott elérési út (fájlkönyvtár) felhasználó által definiált metaadatait egy vagy több név-érték párként állítja be. Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a rendszer eltávolítja az elérési út metaadatait. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata |
| set |
Beállítja a fájlengedélyeket egy elérési úton. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| to |
Az aktuális DataLakePathClient konvertálása DataLakeDirectoryClientre, ha az aktuális elérési út könyvtár. |
| to |
Az aktuális DataLakePathClient átalakítása DataLakeFileClientre, ha az aktuális elérési út egy fájl. |
| update |
Módosítja a hozzáférés-vezérlést egy elérési úton és az alútvonalakon. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
Konstruktor adatai
DataLakeFileClient(string, Pipeline)
Létrehoz egy DataLakeFileClient-példányt az URL-címből és a folyamatból.
new DataLakeFileClient(url: string, pipeline: Pipeline)
Paraméterek
- url
-
string
Egy Azure Storage data lake-fájlra mutató ügyfélsztring, például "https://myaccount.dfs.core.windows.net/filesystem/file". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString".
- pipeline
- Pipeline
A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.
DataLakeFileClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Létrehoz egy DataLakeFileClient-példányt az URL-címből és a hitelesítő adatokból.
new DataLakeFileClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Paraméterek
- url
-
string
Egy Azure Storage data lake-fájlra mutató ügyfélsztring, például "https://myaccount.dfs.core.windows.net/filesystem/file". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
- options
- StoragePipelineOptions
Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.
Tulajdonság adatai
fileSystemName
Az aktuális fájlrendszer neve.
string fileSystemName
Tulajdonság értéke
string
name
Az aktuális elérési út neve (könyvtár vagy fájl).
string name
Tulajdonság értéke
string
Örökölt tulajdonság részletei
accountName
credential
Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Tulajdonság értéke
A DataLakePathClient.credential-tőlörökölt
url
Metódus adatai
append(RequestBodyType, number, number, FileAppendOptions)
Feltölti a fájlhoz fűzendő adatokat. Az adatok csak fájlhoz fűzhetők. Ha perverz módon feltöltött adatokat szeretne alkalmazni egy fájlra, hívja meg a flush billentyűt.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function append(body: RequestBodyType, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>
Paraméterek
- body
- HttpRequestBody
Feltöltendő tartalom.
- offset
-
number
Hozzáfűzés eltolása bájtban.
- length
-
number
A hozzáfűzendő tartalom hossza bájtban.
- options
- FileAppendOptions
Optional. Beállítások adatok hozzáfűzésekor.
Válaszok
Promise<FileAppendResponse>
create(FileCreateOptions)
Hozzon létre egy fájlt.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: FileCreateOptions): Promise<FileCreateResponse>
Paraméterek
- options
- FileCreateOptions
Optional. Beállítások a fájl létrehozásakor.
Válaszok
Promise<FileCreateResponse>
create(PathResourceType, PathCreateOptions)
Hozzon létre egy fájlt.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>
Paraméterek
- resourceType
- PathResourceTypeModel
Az erőforrástípusnak a DataLakeFileClient fájljának kell lennie.
- options
- PathCreateOptions
Optional. Beállítások a fájl létrehozásakor.
Válaszok
Promise<PathCreateResponse>
createIfNotExists(FileCreateIfNotExistsOptions)
Hozzon létre egy fájlt, ha még nem létezik.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: FileCreateIfNotExistsOptions): Promise<FileCreateIfNotExistsResponse>
Paraméterek
- options
- FileCreateIfNotExistsOptions
Optional. Beállítások a fájl létrehozásakor.
Válaszok
Promise<FileCreateIfNotExistsResponse>
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)
Hozzon létre egy fájlt, ha még nem létezik.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>
Paraméterek
- resourceType
- PathResourceTypeModel
Az erőforrástípusnak a DataLakeFileClient fájljának kell lennie.
- options
- PathCreateIfNotExistsOptions
Válaszok
Promise<PathCreateIfNotExistsResponse>
flush(number, FileFlushOptions)
Kiüríti (írja) a korábban hozzáfűzött adatokat egy fájlba.
function flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>
Paraméterek
- position
-
number
A kiürítendő fájlpozíció. Ez a paraméter lehetővé teszi, hogy a hívó párhuzamosan töltse fel az adatokat, és szabályozza a fájlhoz való hozzáfűzés sorrendjét. A fájlhoz hozzáfűzendő adatok feltöltésekor és a korábban feltöltött adatok fájlba való kiürítésekor szükséges. Az értéknek azt a helyet kell megadnia, ahol az adatokat hozzá kell fűzni. A feltöltött adatok nem lesznek azonnal kipirulva vagy megírva a fájlba. A kiürítéshez a korábban feltöltött adatoknak egybefüggőnek kell lenniük, a pozícióparamétert meg kell adni, és meg kell egyeztetni a fájl hosszával az összes adat megírása után, és nem lehet kérelem entitástörzse a kérelemben.
- options
- FileFlushOptions
Optional. Beállítások adatok kiürítésekor.
Válaszok
Promise<FileFlushResponse>
generateSasStringToSign(FileGenerateSasUrlOptions)
Csak megosztott kulcsú hitelesítő adatokkal létrehozott ügyfelek számára érhető el.
Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.
Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: FileGenerateSasUrlOptions): string
Paraméterek
- options
- FileGenerateSasUrlOptions
Nem kötelező paraméterek.
Válaszok
string
Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.
generateSasUrl(FileGenerateSasUrlOptions)
Csak megosztott kulcsú hitelesítő adatokkal létrehozott ügyfelek számára érhető el.
Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.
Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: FileGenerateSasUrlOptions): Promise<string>
Paraméterek
- options
- FileGenerateSasUrlOptions
Nem kötelező paraméterek.
Válaszok
Promise<string>
Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.
generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)
Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.
Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasStringToSign(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string
Paraméterek
- options
- FileGenerateSasUrlOptions
Nem kötelező paraméterek.
- userDelegationKey
- UserDelegationKey
A blobServiceClient.getUserDelegationKey() visszaadott értéke
Válaszok
string
Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.
generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)
Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.
Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>
Paraméterek
- options
- FileGenerateSasUrlOptions
Nem kötelező paraméterek.
- userDelegationKey
- UserDelegationKey
A blobServiceClient.getUserDelegationKey() visszaadott értéke
Válaszok
Promise<string>
Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.
query(string, FileQueryOptions)
JSON- vagy CSV-formátumú fájlok gyors lekérdezése.
Példahasználat (Node.js):
import { DataLakeServiceClient } from "@azure/storage-file-datalake";
const account = "<account>";
const sas = "<sas token>";
const datalakeServiceClient = new DataLakeServiceClient(
`https://${account}.dfs.core.windows.net${sas}`,
);
const fileSystemName = "<file system name>";
const fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);
// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
if (queryResponse.readableStreamBody) {
const responseBuffer = await streamToBuffer(queryResponse.readableStreamBody);
const downloaded = responseBuffer.toString();
console.log(`Query file content: ${downloaded}`);
}
async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
return new Promise((resolve, reject) => {
const chunks: Buffer[] = [];
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éterek
- query
-
string
- options
- FileQueryOptions
Válaszok
Promise<FileReadResponse>
read(number, number, FileReadOptions)
Letölt egy fájlt a szolgáltatásból, beleértve annak metaadatait és tulajdonságait.
- A Node.jsaz adatok olvasható streamelhetőStreamBody-fájlban térnek vissza
- A böngészőkben az adatok ígéretes tartalomban térnek visszaAsBlob
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob
- Példahasználat (Node.js):
import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";
const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
`https://${account}.dfs.core.windows.net`,
new DefaultAzureCredential(),
);
const fileSystemName = "<file system name>";
const fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);
// Get file content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadResponse.readableStreamBody
const downloadResponse = await fileClient.read();
if (downloadResponse.readableStreamBody) {
const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
console.log("Downloaded file content:", downloaded.toString());
}
// [Node.js only] A helper method used to read a Node.js readable stream into a Buffer.
async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
return new Promise((resolve, reject) => {
const chunks: Buffer[] = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
Példa a használatra (böngésző):
import { DataLakeServiceClient } from "@azure/storage-file-datalake";
const account = "<account>";
const sas = "<sas token>";
const datalakeServiceClient = new DataLakeServiceClient(
`https://${account}.dfs.core.windows.net${sas}`,
);
const fileSystemName = "<file system name>";
const fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);
// Get file content from position 0 to the end
// In browsers, get downloaded data by accessing downloadResponse.contentAsBlob
const downloadResponse = await fileClient.read();
if (downloadResponse.contentAsBlob) {
const blob = await downloadResponse.contentAsBlob;
const downloaded = await blob.text();
console.log(`Downloaded file content ${downloaded}`);
}
function read(offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>
Paraméterek
- offset
-
number
Optional. Eltolás a fájl olvasásához, az alapértelmezett érték 0.
- count
-
number
Optional. Hány bájtot kell beolvasni, az alapértelmezett érték az eltolástól a végéig lesz beolvasva.
- options
- FileReadOptions
Optional. A fájlok olvasásának beállításai.
Válaszok
Promise<FileReadResponse>
readToBuffer(Buffer, number, number, FileReadToBufferOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
Egy Data Lake-fájlt egy pufferrel párhuzamosan olvas be. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl olvasásához mindkettőnek 0-t kell megadnia.
Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Ennél nagyobb fájlok esetén fontolja meg readToFile.
function readToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>
Paraméterek
- buffer
-
Buffer
A kitöltéshez szükséges puffernek a darabszámnál nagyobb hosszúságúnak kell lennie
- offset
-
number
A Data Lake-fájl olvasásának helye
- count
-
number
Mennyi adatot kell olvasni. Nem definiált átadáskor felolvassa a végéig
- options
- FileReadToBufferOptions
Válaszok
Promise<Buffer>
readToBuffer(number, number, FileReadToBufferOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL
Egy Data Lake-fájlt egy pufferrel párhuzamosan olvas be. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl olvasásához mindkettőnek 0-t kell megadnia
Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Ennél nagyobb fájlok esetén fontolja meg readToFile.
function readToBuffer(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>
Paraméterek
- offset
-
number
A Data Lake-fájl olvasási helye (bájtban)
- count
-
number
Mennyi adatot (bájtban) kell olvasni. Nem definiált átadáskor felolvassa a végéig
- options
- FileReadToBufferOptions
Válaszok
Promise<Buffer>
readToFile(string, number, number, FileReadOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
Letölt egy Data Lake-fájlt egy helyi fájlba. Sikertelen, ha a megadott fájl elérési útja már kilép. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl letöltéséhez adja meg a 0- és a nem definiált értékeket.
function readToFile(filePath: string, offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>
Paraméterek
- filePath
-
string
- offset
-
number
A fájl letöltésének helye.
- count
-
number
Mennyi adatot kell letölteni. A letöltés a végéhez ér, amikor nem definiált állapotot ad át.
- options
- FileReadOptions
A Data Lake-fájl olvasási lehetőségei.
Válaszok
Promise<FileReadResponse>
A fájlolvasási művelet válaszadatai, de az olvashatóStreamBody beállítása nem definiált, mivel a tartalom már be van olvasva és egy helyi fájlba írva a megadott elérési úton.
setExpiry(PathExpiryOptions, FileSetExpiryOptions)
Beállítja a fájl lejárati idejét, miután ez az idő teljesült, a fájl törlődik.
function setExpiry(mode: PathExpiryOptions, options?: FileSetExpiryOptions): Promise<FileSetExpiryResponse>
Paraméterek
- mode
- FileExpiryMode
- options
- FileSetExpiryOptions
Válaszok
Promise<FileSetExpiryResponse>
upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)
Feltölt egy puffert(Node.js)/Blob/ArrayBuffer/ArrayBufferView fájlt egy fájlba.
function upload(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Paraméterek
- data
-
Blob | ArrayBuffer | ArrayBufferView | Buffer
Buffer(Node), Blob, ArrayBuffer vagy ArrayBufferView
- options
- FileParallelUploadOptions
Válaszok
Promise<FileUploadResponse>
uploadFile(string, FileParallelUploadOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
Feltölt egy helyi fájlt egy Data Lake-fájlba.
function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Paraméterek
- filePath
-
string
A helyi fájl teljes elérési útja
- options
- FileParallelUploadOptions
Válaszok
Promise<FileUploadResponse>
uploadStream(Readable, FileParallelUploadOptions)
CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.
Egy Node.js olvasható streamet tölt fel egy Data Lake-fájlba. Ez a metódus megpróbál létrehozni egy fájlt, majd megkezdi az adattömb feltöltését adattömb alapján. Győződjön meg arról, hogy a stream lehetséges mérete nem haladja meg a FILE_MAX_SIZE_BYTES és az adattömbök lehetséges száma nem haladja meg a BLOCK_BLOB_MAX_BLOCKS.
TELJESÍTMÉNYJAVÍTÁSI TIPPEK:
- A bemeneti stream highWaterMark tulajdonsága jobb, ha ugyanazt az értéket az options.chunkSize paraméterrel állítja be, így elkerülhetők a Puffer.concat() műveletek.
function uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Paraméterek
- stream
-
Readable
Node.js olvasható streamet.
- options
- FileParallelUploadOptions
Válaszok
Promise<FileUploadResponse>
Örökölt metódus részletei
delete(boolean, PathDeleteOptions)
Az aktuális elérési út (könyvtár vagy fájl) törlése.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>
Paraméterek
- recursive
-
boolean
Csak akkor kötelező és érvényes, ha az erőforrás könyvtár. Ha "igaz", a könyvtár alatti összes elérési út törlődik.
- options
- PathDeleteOptions
Optional. Az elérési út törlésekor megadott beállítások.
Válaszok
Promise<PathDeleteResponse>
A DataLakePathClient.deletewebhelyről örökölt
deleteIfExists(boolean, PathDeleteOptions)
Ha létezik, törölje az aktuális elérési utat (könyvtárat vagy fájlt).
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>
Paraméterek
- recursive
-
boolean
Csak akkor kötelező és érvényes, ha az erőforrás könyvtár. Ha "igaz", a könyvtár alatti összes elérési út törlődik.
- options
- PathDeleteOptions
Válaszok
Promise<PathDeleteIfExistsResponse>
exists(PathExistsOptions)
Igaz értéket ad vissza, ha az ügyfél által képviselt Data Lake-fájl létezik; máskülönben hamis.
MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő fájlt más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy a függvény befejezése után más ügyfelek vagy alkalmazások új fájlokat adnak hozzá.
function exists(options?: PathExistsOptions): Promise<boolean>
Paraméterek
- options
- PathExistsOptions
beállítási lehetőségeket a Exists művelethez.
Válaszok
Promise<boolean>
A DataLakePathClient.existswebhelyről örökölt
getAccessControl(PathGetAccessControlOptions)
Egy elérési út (fájlkönyvtár) hozzáférés-vezérlési adatait adja vissza.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>
Paraméterek
- options
- PathGetAccessControlOptions
Optional. Beállítások a fájlhozzáférés-vezérlés lekéréséhez.
Válaszok
Promise<PathGetAccessControlResponse>
A DataLakePathClient.getAccessControlwebhelyről örökölt
getDataLakeLeaseClient(string)
Szerezze be DataLakeLeaseClient, amely az elérési úton (könyvtárban vagy fájlban) lévő bérleteket kezeli.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Paraméterek
- proposeLeaseId
-
string
Optional. Kezdeti javasolt bérletazonosító.
Válaszok
A DataLakePathClient.getDataLakeLeaseClientwebhelyről örökölt
getProperties(PathGetPropertiesOptions)
A felhasználó által definiált metaadatokat, a szabványos HTTP-tulajdonságokat és az elérési út (könyvtár vagy fájl) rendszertulajdonságait adja vissza.
FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér az DataLakeFileSystemClient által visszaadott metaadatkulcsoktól, amelyek a includeMetadata beállítással listáznak elérési utakat, amelyek megőrzik az eredeti burkolatukat.
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>
Paraméterek
- options
- PathGetPropertiesOptions
Optional. Lehetőségek az elérési út tulajdonságainak lekérésekor.
Válaszok
Promise<PathGetPropertiesResponse>
A DataLakePathClient.getPropertieswebhelyről örökölt
move(string, PathMoveOptions)
Könyvtár vagy fájl áthelyezése ugyanabban a fájlrendszerben.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Paraméterek
- destinationPath
-
string
A célkönyvtár elérési útja, például a "könyvtár" vagy a "könyvtár/fájl" fájl elérési útja. Ha a destinationPath sassal van hitelesítve, adja hozzá az SAS-t a célútvonalhoz, például "könyvtár/fájl?sasToken".
- options
- PathMoveOptions
Optional. Könyvtár vagy fájl áthelyezésekor megadott beállítások.
Válaszok
Promise<PathMoveResponse>
A DataLakePathClient.movewebhelyről örökölt
move(string, string, PathMoveOptions)
Könyvtár vagy fájl áthelyezése másik fájlrendszerbe.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Paraméterek
- destinationFileSystem
-
string
Cél fájlrendszer, például "fájlrendszer".
- destinationPath
-
string
Célkönyvtár elérési útja, például "könyvtár" vagy fájl elérési útja "könyvtár/fájl" Ha a destinationPath sas-hitelesítéssel van hitelesítve, adja hozzá az SAS-t a cél elérési úthoz, például "könyvtár/fájl?sasToken".
- options
- PathMoveOptions
Optional. Könyvtár vagy fájl áthelyezésekor megadott beállítások.
Válaszok
Promise<PathMoveResponse>
A DataLakePathClient.movewebhelyről örökölt
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Eltávolítja a hozzáférés-vezérlést egy elérési úton és az alútvonalakon.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Paraméterek
A fájl vagy könyvtár POSIX-hozzáférés-vezérlési listája.
Optional. Beállítások
Válaszok
A DataLakePathClient.removeAccessControlRecursive-tólörökölt
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Adja meg az elérési út (fájlkönyvtár) hozzáférés-vezérlési adatait.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>
Paraméterek
- acl
A fájl vagy könyvtár POSIX-hozzáférés-vezérlési listája.
- options
- PathSetAccessControlOptions
Optional. Beállítások az elérési út hozzáférés-vezérlésének beállításához.
Válaszok
Promise<PathSetAccessControlResponse>
A DataLakePathClient.setAccessControlwebhelyről örökölt
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Beállítja a hozzáférés-vezérlést egy elérési útvonalon és alútvonalakon.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Paraméterek
- acl
A fájl vagy könyvtár POSIX-hozzáférés-vezérlési listája.
Optional. Beállítások
Válaszok
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Beállítja a rendszertulajdonságokat az elérési úton (könyvtárban vagy fájlban).
Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejlécekhez, a blob HTTP-fejlécei érték nélkül törlődnek.
Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>
Paraméterek
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Válaszok
Promise<PathSetHttpHeadersResponse>
setMetadata(Metadata, PathSetMetadataOptions)
A megadott elérési út (fájlkönyvtár) felhasználó által definiált metaadatait egy vagy több név-érték párként állítja be.
Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a rendszer eltávolítja az elérési út metaadatait.
Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>
Paraméterek
- metadata
- Metadata
Optional. Cserélje le a meglévő metaadatokat erre az értékre. Ha nincs megadva érték, a meglévő metaadatok el lesznek távolítva.
- options
- PathSetMetadataOptions
Optional. Beállítások az elérési út metaadatainak beállításához.
Válaszok
Promise<PathSetMetadataResponse>
A DataLakePathClient.setMetadatawebhelyről örökölt
setPermissions(PathPermissions, PathSetPermissionsOptions)
Beállítja a fájlengedélyeket egy elérési úton.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>
Paraméterek
- permissions
- PathPermissions
A POSIX hozzáférési engedélyei a fájl tulajdonosához, a fájltulajdonosi csoporthoz és másokhoz.
- options
- PathSetPermissionsOptions
Optional. Az elérésiút-engedélyek beállításának beállításai.
Válaszok
Promise<PathSetPermissionsResponse>
A DataLakePathClient.setPermissionswebhelyről örökölt
toDirectoryClient()
Az aktuális DataLakePathClient konvertálása DataLakeDirectoryClientre, ha az aktuális elérési út könyvtár.
function toDirectoryClient(): DataLakeDirectoryClient
Válaszok
toFileClient()
Az aktuális DataLakePathClient átalakítása DataLakeFileClientre, ha az aktuális elérési út egy fájl.
function toFileClient(): DataLakeFileClient
Válaszok
A DataLakePathClient.toFileClient-tőlörökölt
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Módosítja a hozzáférés-vezérlést egy elérési úton és az alútvonalakon.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Paraméterek
- acl
A fájl vagy könyvtár POSIX-hozzáférés-vezérlési listája.
Optional. Beállítások
Válaszok
A DataLakePathClient.updateAccessControlRecursivewebhelyről örökölt