Skip to main content

FilesDataSource

Defined in: js-api/src/dapi.ts:2930

Provides access to file operations in the Datagrok file system.

Allows reading, writing, listing, and managing files and directories in user file shares and data connections.

Access via grok.dapi.files.

Example​

// List files
const files = await grok.dapi.files.list('System:AppData/MyApp');

// Read a file
const content = await grok.dapi.files.readAsText('System:AppData/MyApp/config.json');

// Write a file
await grok.dapi.files.writeAsText('System:AppData/MyApp/output.txt', 'Hello, World!');

Constructors​

Constructor​

new FilesDataSource(root?): FilesDataSource

Defined in: js-api/src/dapi.ts:2932

Parameters​

ParameterTypeDefault value
rootstring''

Returns​

FilesDataSource

Methods​

createDirectory()​

createDirectory(file): Promise<void>

Defined in: js-api/src/dapi.ts:3090

Creates directory Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo

Returns​

Promise<void>


delete()​

delete(file): Promise<void>

Defined in: js-api/src/dapi.ts:2954

Deletes a file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo

Returns​

Promise<void>


exists()​

exists(file): Promise<boolean>

Defined in: js-api/src/dapi.ts:2938

Checks if a file exists. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo

Returns​

Promise<boolean>


list()​

Call Signature​

list(file, options?): Promise<FileInfo[]>

Defined in: js-api/src/dapi.ts:2983

Lists files according to a search pattern. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​
ParameterTypeDescription
filestring | FileInfofolder
options?FileListOptions-
Returns​

Promise<FileInfo[]>

Call Signature​

list(file, recursive?, searchPattern?): Promise<FileInfo[]>

Defined in: js-api/src/dapi.ts:2984

Lists files according to a search pattern. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​
ParameterTypeDescription
filestring | FileInfofolder
recursive?booleanwhether to search in folders recursively
searchPattern?string | nullsearch pattern, such as part of a filename or extension, e.g., "filename-prefix" and "csv"
Returns​

Promise<FileInfo[]>


move()​

move(files, newPath): Promise<void>

Defined in: js-api/src/dapi.ts:2961

Moves a file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filesstring[] | FileInfo[]
newPathstring

Returns​

Promise<void>


readAsBytes()​

readAsBytes(file): Promise<Uint8Array<ArrayBufferLike>>

Defined in: js-api/src/dapi.ts:3071

Reads a file as bytes. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo

Returns​

Promise<Uint8Array<ArrayBufferLike>>


readAsText()​

readAsText(file): Promise<string>

Defined in: js-api/src/dapi.ts:3058

Reads a file as string. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo

Returns​

Promise<string>


readBinaryDataFrames()​

readBinaryDataFrames(file): Promise<DataFrame[]>

Defined in: js-api/src/dapi.ts:3077

Reads a d42 file as a list of dataframes.

Parameters​

ParameterType
filestring | FileInfo

Returns​

Promise<DataFrame[]>


readCsv()​

readCsv(file, options?): Promise<DataFrame>

Defined in: js-api/src/dapi.ts:3065

Reads CSV as DataFrame. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo
options?CsvImportOptions

Returns​

Promise<DataFrame>


readFilesAsBlobs()​

readFilesAsBlobs(folder, recursive?, ext?): Promise<{[key: string]: Blob; }>

Defined in: js-api/src/dapi.ts:2996

Reads the entire contents of a folder and returns an object. The resulting object's keys are the file names relative to the folder path, and the corresponding values are of the Blob type.

Parameters​

ParameterTypeDefault valueDescription
folderstring | FileInfoundefined-
recursivebooleanfalsewhether to read files in folders recursively
extstring | undefinedundefinedfiles extension

Returns​

Promise<{[key: string]: Blob; }>


readFilesAsJson()​

readFilesAsJson(folder, recursive?, ext?): Promise<{[key: string]: any; }>

Defined in: js-api/src/dapi.ts:3027

Reads the entire contents of a folder and returns an object. The resulting object's keys are the file names relative to the folder path, and the corresponding values are JSON objects. If conversion to a JSON fails, the file will be skipped.

Parameters​

ParameterTypeDefault valueDescription
folderstring | FileInfoundefined-
recursivebooleanfalsewhether to read files in folders recursively
extstring | undefinedundefinedfiles extension

Returns​

Promise<{[key: string]: any; }>


readFilesAsString()​

readFilesAsString(folder, recursive?, ext?): Promise<{[key: string]: string; }>

Defined in: js-api/src/dapi.ts:3044

Reads the entire contents of a folder and returns an object. The resulting object's keys are the file names relative to the folder path, and the corresponding values are strings. If conversion to a string fails, the file will be skipped.

Parameters​

ParameterTypeDefault valueDescription
folderstring | FileInfoundefined-
recursivebooleanfalsewhether to read files in folders recursively
extstring | undefinedundefinedfiles extension

Returns​

Promise<{[key: string]: string; }>


rename()​

rename(file, newName): Promise<void>

Defined in: js-api/src/dapi.ts:2971

Renames a file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo
newNamestring

Returns​

Promise<void>


write()​

write(file, blob?): Promise<void>

Defined in: js-api/src/dapi.ts:3097

Writes a file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo
blob?number[] | Uint8Array<ArrayBufferLike>

Returns​

Promise<void>


writeAsText()​

writeAsText(file, data): Promise<void>

Defined in: js-api/src/dapi.ts:3105

Writes a text file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters​

ParameterType
filestring | FileInfo
datastring

Returns​

Promise<void>


writeBinaryDataFrames()​

writeBinaryDataFrames(file, dataFrames): Promise<void>

Defined in: js-api/src/dapi.ts:3083

Writes a list of dataframes as a d42 file.

Parameters​

ParameterType
filestring | FileInfo
dataFramesDataFrame[]

Returns​

Promise<void>