Kinetica, via KiFS, provides support for staging files within the database for subsequent ingestion. The file structure consists of a single layer of top-level directories, with each file contained within one of those directories. File names can contain / characters to give the appearance of existing under a hierarchy of one or more sub-directories.
Directory features accessible via SQL include:
File features accessible via SQL include:
For directory permission management, see:
CREATE DIRECTORY
Creates a new KiFS directory under which files can be uploaded and used for data loading.
|
|
Parameters | Description |
---|---|
<directory name> | Name of the directory to create. |
For example, to create a directory, kdata:
|
|
DROP DIRECTORY
Removes an existing KiFS directory.
|
|
Parameters | Description | ||||
---|---|---|---|---|---|
<directory name> | Name of the directory to remove. | ||||
IF EXISTS | Optional error-suppression clause; if specified, no error will be returned if the given directory does not exist. | ||||
WITH OPTIONS | Optional indicator that a comma-delimited list of option/value assignments will follow.
|
For example, to delete a directory, kbackup:
|
|
To delete a directory, kdata, and all files in it, suppressing the error if it doesn't exist:
|
|
SHOW DIRECTORY
Outputs the DDL statement required to reconstruct the given KiFS directory or all KiFS directories.
|
|
Parameters | Description |
---|---|
<directory name> | Name of the existing directory for which DDL will be output. Use * instead to output DDL of all directories. |
Note
The response to SHOW DIRECTORY is a single-column result set with the DDL statement as the value in the DDL column.
For example, to output the DDL for a directory, kdata:
|
|
To output the DDL for all directories:
|
|
DESCRIBE DIRECTORY
Outputs detail about one or all KiFS directories.
|
|
Parameters | Description |
---|---|
<directory name> | Name of the existing directory for which detail will be output. Use * instead to output detail of all directories. |
Note
The response to DESCRIBE DIRECTORY is a four-column result set:
- DIRECTORY_NAME - name of the directory
- CREATED_BY - user ID of the user who created the directory
- CREATION_TIME - date/time at which the directory was created
- PERMISSION - highest level of access to the directory the command issuer has
For example, to output the detail about a directory, kdata:
|
|
To output the detail for all directories:
|
|
UPLOAD FILE
Uploads file(s) local to the database client into KiFS, within the given directory.
Note
This command is only available through KiSQL or database clients configured with the Kinetica JDBC driver.
|
|
Parameters | Description | ||||||
---|---|---|---|---|---|---|---|
<file path(s)> | Local path(s) of the file(s) to upload to KiFS, as a comma-separated list of single-quoted file paths; wildcards (*) can be used to specify a group of files.
|
||||||
<kifs path> | Path in KiFS; this can be either the name of a directory or a directory followed by virtual subdirectories separated by / characters. For example, uploading a file named 2021.q1.csv to:
Note Only the directory specified within this path must exist for the upload to succeed. Any virtual subdirectories added to this path do not need to exist before uploading. |
For example, to upload a file to directory, kdata:
|
|
To upload several files to a directory, kdata:
|
|
DOWNLOAD FILE
Downloads file(s) from KiFS into a local directory.
Note
This command is only available through KiSQL or database clients configured with the Kinetica JDBC driver.
|
|
Parameters | Description | ||||||
---|---|---|---|---|---|---|---|
<kifs file path(s)> | KiFS file(s) to download to the local file system, as a comma-separated list of single-quoted file paths.
|
||||||
<local directory> | Local directory path into which files will be downloaded. |
For example, to download a KiFS file to a local directory, /tmp/data:
|
|
To download several KiFS files to a local directory, /tmp/data:
|
|
DROP FILE
Deletes an existing KiFS file.
|
|
Parameters | Description |
---|---|
<kifs file path(s)> | KiFS file(s) to delete, as a comma-separated list of single-quoted file paths. |
IF EXIST[S] | Optional error-suppression clause; if specified, no error will be returned if the given file(s) do not exist. |
For example, to delete a KiFS file:
|
|
To delete several KiFS files, suppressing the error if any don't exist:
|
|
DESCRIBE FILE
Outputs detail about one or all KiFS files.
|
|
Parameters | Description | ||||||
---|---|---|---|---|---|---|---|
<kifs path(s)> | Name(s) of existing directories and/or files for which detail will be output, as a comma-separated list of single-quoted paths.
|
Note
The response to DESCRIBE FILE is a four-column result set:
- FILE_NAME - name of the directory
- SIZE - size of the file in bytes
- CREATED_BY - user ID of the user who created the file
- CREATION_TIME - date/time at which the file was created
For example, to output a listing of all files under the KiFS directory, kdata:
|
|
To output a listing of specific files under the KiFS directory, kdata:
|
|