Skip to main content

KiFS (Kinetica File System) API module.

This module provides a high-level API for interacting with Kinetica’s distributed file system (KiFS). It supports file uploads, downloads, directory management, and file operations with support for both single-file and multi-part transfers.

Features

  • File Upload: Upload single files or multiple files with glob pattern support
  • File Download: Download single files or entire directories
  • Directory Management: Create, delete, and list KiFS directories
  • Progress Callbacks: Optional listeners for tracking upload/download progress
  • Multi-part Transfers: Automatic handling of large files using chunked transfers
  • Glob Pattern Support: Use patterns like *.csv or data/**/*.json for batch operations

Example

Modules

Names of the ingest options.
Names of the table creation options.

Structs

Options for file download operations.
A simple download listener that wraps callback functions.
A simple upload listener that wraps callback functions.
Options for ingesting files: the options of /insert/records/fromfiles.
What an ingest did.
Information about a KiFS directory.
Main class for interacting with the Kinetica File System (KiFS).
Options for the KiFS file handler.
Information about a KiFS file.
Information about a part of a multi-part download.
Information about a multi-part upload operation.
A no-op download listener that ignores all callbacks. Useful for operations where progress tracking is not needed.
A no-op upload listener that ignores all callbacks. Useful for operations where progress tracking is not needed.
Result of an upload or download operation.
Options for the table an ingest creates: the create table options of /insert/records/fromfiles.
Options for file upload operations.

Enums

How the server handles a record it cannot insert.
The type of the files ingested.
Multi-part operation stages for upload/download. Where there is no stage, an Option<MultiPartOperation> is None.
Indicates whether an operation is an upload or download.
How a table created for the ingest is partitioned.
How the server infers the types of the columns of a table it creates.

Constants

pub const KIFS_PATH_PREFIX: &str = “kifs://“;

Prefix to use when referencing KiFS files; e.g., for purposes of file ingest.

pub const KIFS_PATH_SEPARATOR: &str = ”/“;

Separator character between a KiFS directory and KiFS file name. This can also be used within a file name to create a virtual directory within a path.

pub const REMOTE_USER_HOME_DIR_PREFIX: &str = ”~“;

Alias for a user’s home directory.

Traits

Listener trait for file download progress callbacks.
Listener trait for file upload progress callbacks.