Files & Directories (KiFS)

CREATE DIRECTORY

Creates a new KiFS directory under which files can be uploaded and used for data loading.

1
2

CREATE DIRECTORY '<directory name>'
[WITH OPTIONS (data_limit = <data limit value>)]

For example, to create a directory, kdata, with no size limit:

1

CREATE DIRECTORY 'kdata'

To create a directory, fs_limited, with a 1,000,000 byte maximum capacity:

1
2

CREATE DIRECTORY 'fs_limited'
WITH OPTIONS (data_limit = 1000000)

ALTER DIRECTORY

Alters the configuration of an existing KiFS directory.

The following facet of a directory can be altered:

• Data Limit

1
2

ALTER DIRECTORY '<directory name>'
SET data_limit = <data limit value>

1
2

ALTER DIRECTORY 'fs_limited'
SET data_limit = 10000000

LIST DIRECTORY

Outputs detail about one or all KiFS directories.

1

<LIST|SHOW|DESC[RIBE]> DIRECTOR[Y|IES] < '<directory name>' | * >

For example, to output the detail about a directory, kdata:

1

LIST DIRECTORY 'kdata'

To output the detail for all directories:

1

LIST DIRECTORIES *

DOWNLOAD DIRECTORY

Downloads all files under a directory in KiFS into a local directory.

1
2

DOWNLOAD [DIRECTORY] <kifs directory>
INTO '<local directory>'

For example, to download all files in a KiFS directory to a local directory, /tmp:

1
2

DOWNLOAD DIRECTORY 'kdata'
INTO '/tmp'

DROP DIRECTORY

Removes an existing KiFS directory.

1
2

DROP DIRECTORY [IF EXISTS] '<directory name>'
[WITH OPTIONS ('<option name>' = '<option value>'[,...])]

For example, to delete a directory, kbackup:

1

DROP DIRECTORY 'kbackup'

To delete a directory, kdata, and all files in it, suppressing the error if it doesn't exist:

1
2

DROP DIRECTORY IF EXISTS 'kdata'
WITH OPTIONS ('recursive' = 'true')

UPLOAD FILE

Uploads file(s) local to the database client into KiFS, within the given directory.

1
2

UPLOAD FILE[S] <file path(s)>
INTO '<kifs path>'

For example, to upload a file to a directory, kdata:

1
2

UPLOAD FILE '../data/products.csv'
INTO 'kdata'

To upload several files to a directory, kdata:

1
2

UPLOAD FILES '../data/p*.ssv', '../data/employee.*'
INTO 'kdata'

UPLOAD URL

Uploads file(s) from one or more URLs into KiFS, in one or more directories. There should be a corresponding KiFS full file path specified for each URL specified--the KiFS file name will not be derived from any part of the given URL.

1
2

UPLOAD URL <url(s)>
INTO <kifs path(s)>

For example, to upload the Kinetica JDBC Driver in GitHub to file kinetica-jdbc-fullshaded.jar under directory drivers:

1
2

UPLOAD URL 'https://github.com/kineticadb/kinetica-client-jdbc/raw/master/kinetica-jdbc-7.2.2.3-fullshaded.jar'
INTO 'drivers/kinetica-jdbc-fullshaded.jar';

To upload the Kinetica JDBC Driver and the corresponding change log in GitHub to files kjdbc-7.2.jar & kjdbc-CHANGELOG.md, respectively, under directory drivers:

1
2
3
4
5
6

UPLOAD URL
    'https://github.com/kineticadb/kinetica-client-jdbc/raw/master/kinetica-jdbc-7.2.2.3-fullshaded.jar',
    'https://github.com/kineticadb/kinetica-client-jdbc/raw/master/CHANGELOG.md'
INTO
    'drivers/kjdbc-7.2.jar',
    'drivers/kjdbc-CHANGELOG.md';

LIST FILE

Outputs detail about one or all KiFS files.

1

<LIST|SHOW|DESC[RIBE]> FILE[S] <kifs path(s)>

For example, to output a listing of all files under the KiFS directory, kdata:

1

LIST FILES 'kdata'

To output a listing of specific files under the KiFS directory, kdata:

1

LIST FILES 'kdata/products.csv', 'kdata/employee.parquet'

DOWNLOAD FILE

Downloads file(s) from KiFS into a local directory.

1
2

DOWNLOAD [FILE[S]] <kifs file path(s)>
INTO '<local directory>'

For example, to download a KiFS file to a local directory, /tmp:

1
2

DOWNLOAD FILE 'kdata/products.csv'
INTO '/tmp'

To download several KiFS files to a local directory, /tmp:

1
2

DOWNLOAD FILES 'kdata/products.ssv', 'kdata/employee.parquet'
INTO '/tmp'

DROP FILE

Deletes an existing KiFS file.

1

DROP FILE[S] [IF EXIST[S]] <kifs file path(s)>

For example, to delete a KiFS file:

1

DROP FILE 'kdata/products.csv'

To delete several KiFS files, suppressing the error if any don't exist:

1

DROP FILES IF EXIST 'kdata/products.csv', 'kdata/employee.parquet'