> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.FileSystem.KineticaFileHandler > kinetica.FileSystem.KineticaFileHandler — Kinetica C# API

Main class for handling file operations with Kinetica's KiFS (Kinetica File System). More...

Classes
class   Options
  Options for configuring the KineticaFileHandler behavior. More...
 

Public Member Functions
  KineticaFileHandler (Kinetica db)
  Constructs a KineticaFileHandler with the specified Kinetica connection.
 
  KineticaFileHandler (Kinetica db, Options options)
  Constructs a KineticaFileHandler with the specified Kinetica connection and options.
 
void  Upload (string fileName, string remoteDirName)
  Uploads a single file to a KiFS directory using default options.
 
void  Upload (string fileName, string remoteDirName, UploadOptions? uploadOptions, IFileUploadListener? callback)
  Uploads a single file to a KiFS directory.
 
void  Upload (IList\< string > fileNames, string remoteDirName)
  Uploads multiple files to a KiFS directory using default options.
 
void  Upload (IList\< string > fileNames, string remoteDirName, UploadOptions? uploadOptions, IFileUploadListener? callback)
  Uploads multiple files to a KiFS directory.
 
async Task  UploadAsync (IList\< string > fileNames, string remoteDirName, UploadOptions? uploadOptions=null, IFileUploadListener? callback=null)
  Uploads files asynchronously to a KiFS directory.
 
void  Download (string fileName, string localDirName)
  Downloads a single file from KiFS to a local directory using default options.
 
void  Download (string fileName, string localDirName, DownloadOptions? downloadOptions, IFileDownloadListener? callback)
  Downloads a single file from KiFS to a local directory.
 
void  Download (IList\< string > fileNames, string localDirName)
  Downloads multiple files from KiFS to a local directory using default options.
 
void  Download (IList\< string > fileNames, string localDirName, DownloadOptions? downloadOptions, IFileDownloadListener? callback)
  Downloads multiple files from KiFS to a local directory.
 
void  DownloadDirectory (string remoteDirName, string localDirName, DownloadOptions? downloadOptions=null, IFileDownloadListener? callback=null)
  Downloads all files in a KiFS directory to a local directory.
 
async Task  DownloadAsync (IList\< string > fileNames, string localDirName, DownloadOptions? downloadOptions=null, IFileDownloadListener? callback=null)
  Downloads files asynchronously from KiFS to a local directory.
 
void  CreateDirectory (string remoteDirName)
  Creates a KiFS directory, suppressing error if it already exists.
 
void  CreateDirectory (string remoteDirName, bool noErrorIfExists)
  Creates a KiFS directory.
 
void  DeleteDirectory (string remoteDirName)
  Deletes a KiFS directory and all files under it, suppressing error if it doesn't exist.
 
void  DeleteDirectory (string remoteDirName, bool recursive, bool noErrorIfNotExists)
  Deletes a KiFS directory.
 
IList\< KifsDirectoryInfo >  ShowDirectories (IList\< string > remoteDirNames)
  Returns statistics about the given KiFS directories.
 
IList\< KifsDirectoryInfo >  ShowDirectory (string remoteDirName)
  Returns statistics about a single KiFS directory.
 
IList\< KifsDirectoryInfo >  ShowAllDirectories ()
  Returns statistics about all KiFS directories.
 
void  DeleteFiles (IList\< string > fileNames)
  Deletes files from KiFS, suppressing error if files don't exist.
 
void  DeleteFiles (IList\< string > fileNames, bool noErrorIfNotExists)
  Deletes files from KiFS.
 
void  DeleteFilesInDirectory (string remoteDirName)
  Deletes all files in a KiFS directory.
 
void  DeleteFilesInDirectory (string remoteDirName, bool noErrorIfNotExists)
  Deletes all files in a KiFS directory.
 
IList\< KifsFileInfo >  ShowFiles (IList\< string > remotePaths)
  Returns statistics about the given KiFS files.
 
bool  KifsDirectoryExists (string dirName)
  Checks whether a KiFS directory exists.
 
bool  KifsDirectoriesExist (ISet\< string > dirNames)
  Checks whether multiple KiFS directories exist.
 
bool  KifsFileExists (string fileName)
  Checks whether a KiFS file exists.
 
  KineticaFileHandler (Kinetica db)
  Constructs a KineticaFileHandler with the specified Kinetica connection.
 
  KineticaFileHandler (Kinetica db, Options options)
  Constructs a KineticaFileHandler with the specified Kinetica connection and options.
 
void  Upload (string fileName, string remoteDirName)
  Uploads a single file to a KiFS directory using default options.
 
void  Upload (string fileName, string remoteDirName, UploadOptions? uploadOptions, IFileUploadListener? callback)
  Uploads a single file to a KiFS directory.
 
void  Upload (IList\< string > fileNames, string remoteDirName)
  Uploads multiple files to a KiFS directory using default options.
 
void  Upload (IList\< string > fileNames, string remoteDirName, UploadOptions? uploadOptions, IFileUploadListener? callback)
  Uploads multiple files to a KiFS directory.
 
async Task  UploadAsync (IList\< string > fileNames, string remoteDirName, UploadOptions? uploadOptions=null, IFileUploadListener? callback=null)
  Uploads files asynchronously to a KiFS directory.
 
void  Download (string fileName, string localDirName)
  Downloads a single file from KiFS to a local directory using default options.
 
void  Download (string fileName, string localDirName, DownloadOptions? downloadOptions, IFileDownloadListener? callback)
  Downloads a single file from KiFS to a local directory.
 
void  Download (IList\< string > fileNames, string localDirName)
  Downloads multiple files from KiFS to a local directory using default options.
 
void  Download (IList\< string > fileNames, string localDirName, DownloadOptions? downloadOptions, IFileDownloadListener? callback)
  Downloads multiple files from KiFS to a local directory.
 
void  DownloadDirectory (string remoteDirName, string localDirName, DownloadOptions? downloadOptions=null, IFileDownloadListener? callback=null)
  Downloads all files in a KiFS directory to a local directory.
 
async Task  DownloadAsync (IList\< string > fileNames, string localDirName, DownloadOptions? downloadOptions=null, IFileDownloadListener? callback=null)
  Downloads files asynchronously from KiFS to a local directory.
 
void  CreateDirectory (string remoteDirName)
  Creates a KiFS directory, suppressing error if it already exists.
 
void  CreateDirectory (string remoteDirName, bool noErrorIfExists)
  Creates a KiFS directory.
 
void  DeleteDirectory (string remoteDirName)
  Deletes a KiFS directory and all files under it, suppressing error if it doesn't exist.
 
void  DeleteDirectory (string remoteDirName, bool recursive, bool noErrorIfNotExists)
  Deletes a KiFS directory.
 
IList\< KifsDirectoryInfo >  ShowDirectories (IList\< string > remoteDirNames)
  Returns statistics about the given KiFS directories.
 
IList\< KifsDirectoryInfo >  ShowDirectory (string remoteDirName)
  Returns statistics about a single KiFS directory.
 
IList\< KifsDirectoryInfo >  ShowAllDirectories ()
  Returns statistics about all KiFS directories.
 
void  DeleteFiles (IList\< string > fileNames)
  Deletes files from KiFS, suppressing error if files don't exist.
 
void  DeleteFiles (IList\< string > fileNames, bool noErrorIfNotExists)
  Deletes files from KiFS.
 
void  DeleteFilesInDirectory (string remoteDirName)
  Deletes all files in a KiFS directory.
 
void  DeleteFilesInDirectory (string remoteDirName, bool noErrorIfNotExists)
  Deletes all files in a KiFS directory.
 
IList\< KifsFileInfo >  ShowFiles (IList\< string > remotePaths)
  Returns statistics about the given KiFS files.
 
bool  KifsDirectoryExists (string dirName)
  Checks whether a KiFS directory exists.
 
bool  KifsDirectoriesExist (ISet\< string > dirNames)
  Checks whether multiple KiFS directories exist.
 
bool  KifsFileExists (string fileName)
  Checks whether a KiFS file exists.
 

Static Public Attributes
const string  KifsPathSeparator = "/"
  Separator character between a KiFS directory and file name.
 
const string  KifsPathPrefix = "kifs\://"
  Prefix to use when referencing KiFS files (e.g., for file ingest).
 
const string  RemoteUserHomeDirPrefix = "\~"
  Alias for a user's home directory.
 
const long  DefaultFileSizeToSplit = 62914560
  Default file size threshold for multi-part uploads (60 MB).
 
const int  DefaultThreadPoolSize = 5
  Default thread pool size for file operations.
 

Properties
Options  FileHandlerOptions \[get]
  Gets the options for this file handler.
 

Detailed Description

Main class for handling file operations with Kinetica's KiFS (Kinetica File System).

Provides methods to upload, download, and manage files and directories in KiFS.

This class exposes the KiFS API for file operations including:

  • Upload files to KiFS
  • Download files from KiFS
  • Create and delete directories
  • List files and directories
  • Check existence of files and directories

Supported file path patterns include standard Glob syntax (e.g., \*.csv, data/‍\*\*, file\_?.txt).

Definition at line 21 of file KineticaFileHandler.cs.

Constructor & Destructor Documentation

◆ KineticaFileHandler() \[1/4]

kinetica.FileSystem.KineticaFileHandler.KineticaFileHandler ( Kinetica db )
inline

Constructs a KineticaFileHandler with the specified Kinetica connection.

Parameters
db The Kinetica instance used to access KiFS.

Definition at line 56 of file KineticaFileHandler.cs.

◆ KineticaFileHandler() \[2/4]

kinetica.FileSystem.KineticaFileHandler.KineticaFileHandler ( Kinetica db,
Options options )
inline

Constructs a KineticaFileHandler with the specified Kinetica connection and options.

Parameters
db The Kinetica instance used to access KiFS.
options Options for configuring file transfer behavior.

Definition at line 65 of file KineticaFileHandler.cs.

◆ KineticaFileHandler() \[3/4]

kinetica.FileSystem.KineticaFileHandler.KineticaFileHandler ( Kinetica db )
inline

Constructs a KineticaFileHandler with the specified Kinetica connection.

Parameters
db The Kinetica instance used to access KiFS.

Definition at line 56 of file KineticaFileHandler.cs.

◆ KineticaFileHandler() \[4/4]

kinetica.FileSystem.KineticaFileHandler.KineticaFileHandler ( Kinetica db,
Options options )
inline

Constructs a KineticaFileHandler with the specified Kinetica connection and options.

Parameters
db The Kinetica instance used to access KiFS.
options Options for configuring file transfer behavior.

Definition at line 65 of file KineticaFileHandler.cs.

Member Function Documentation

◆ CreateDirectory() \[1/4]

void kinetica.FileSystem.KineticaFileHandler.CreateDirectory ( string remoteDirName )
inline

Creates a KiFS directory, suppressing error if it already exists.

Parameters
remoteDirName Name of the KiFS directory to create.

Definition at line 485 of file KineticaFileHandler.cs.

◆ CreateDirectory() \[2/4]

void kinetica.FileSystem.KineticaFileHandler.CreateDirectory ( string remoteDirName )
inline

Creates a KiFS directory, suppressing error if it already exists.

Parameters
remoteDirName Name of the KiFS directory to create.

Definition at line 485 of file KineticaFileHandler.cs.

◆ CreateDirectory() \[3/4]

void kinetica.FileSystem.KineticaFileHandler.CreateDirectory ( string remoteDirName,
bool noErrorIfExists )
inline

Creates a KiFS directory.

Parameters
remoteDirName Name of the KiFS directory to create.
noErrorIfExists Whether to suppress error if directory already exists.

Definition at line 495 of file KineticaFileHandler.cs.

◆ CreateDirectory() \[4/4]

void kinetica.FileSystem.KineticaFileHandler.CreateDirectory ( string remoteDirName,
bool noErrorIfExists )
inline

Creates a KiFS directory.

Parameters
remoteDirName Name of the KiFS directory to create.
noErrorIfExists Whether to suppress error if directory already exists.

Definition at line 495 of file KineticaFileHandler.cs.

◆ DeleteDirectory() \[1/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteDirectory ( string remoteDirName )
inline

Deletes a KiFS directory and all files under it, suppressing error if it doesn't exist.

Parameters
remoteDirName Name of the KiFS directory to delete.

Definition at line 511 of file KineticaFileHandler.cs.

◆ DeleteDirectory() \[2/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteDirectory ( string remoteDirName )
inline

Deletes a KiFS directory and all files under it, suppressing error if it doesn't exist.

Parameters
remoteDirName Name of the KiFS directory to delete.

Definition at line 511 of file KineticaFileHandler.cs.

◆ DeleteDirectory() \[3/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteDirectory ( string remoteDirName,
bool recursive,
bool noErrorIfNotExists )
inline

Deletes a KiFS directory.

Parameters
remoteDirName Name of the KiFS directory to delete.
recursive Whether to delete all files and subdirectories.
noErrorIfNotExists Whether to suppress error if directory doesn't exist.

Definition at line 522 of file KineticaFileHandler.cs.

◆ DeleteDirectory() \[4/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteDirectory ( string remoteDirName,
bool recursive,
bool noErrorIfNotExists )
inline

Deletes a KiFS directory.

Parameters
remoteDirName Name of the KiFS directory to delete.
recursive Whether to delete all files and subdirectories.
noErrorIfNotExists Whether to suppress error if directory doesn't exist.

Definition at line 522 of file KineticaFileHandler.cs.

◆ DeleteFiles() \[1/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteFiles ( IList\< string > fileNames )
inline

Deletes files from KiFS, suppressing error if files don't exist.

Parameters
fileNames List of KiFS file paths to delete.

Definition at line 629 of file KineticaFileHandler.cs.

◆ DeleteFiles() \[2/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteFiles ( IList\< string > fileNames )
inline

Deletes files from KiFS, suppressing error if files don't exist.

Parameters
fileNames List of KiFS file paths to delete.

Definition at line 629 of file KineticaFileHandler.cs.

◆ DeleteFiles() \[3/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteFiles ( IList\< string > fileNames,
bool noErrorIfNotExists )
inline

Deletes files from KiFS.

Parameters
fileNames List of KiFS file paths to delete.
noErrorIfNotExists Whether to suppress error if files don't exist.

Definition at line 639 of file KineticaFileHandler.cs.

◆ DeleteFiles() \[4/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteFiles ( IList\< string > fileNames,
bool noErrorIfNotExists )
inline

Deletes files from KiFS.

Parameters
fileNames List of KiFS file paths to delete.
noErrorIfNotExists Whether to suppress error if files don't exist.

Definition at line 639 of file KineticaFileHandler.cs.

◆ DeleteFilesInDirectory() \[1/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteFilesInDirectory ( string remoteDirName )
inline

Deletes all files in a KiFS directory.

Parameters
remoteDirName Name of the KiFS directory containing files to delete.

Definition at line 655 of file KineticaFileHandler.cs.

◆ DeleteFilesInDirectory() \[2/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteFilesInDirectory ( string remoteDirName )
inline

Deletes all files in a KiFS directory.

Parameters
remoteDirName Name of the KiFS directory containing files to delete.

Definition at line 655 of file KineticaFileHandler.cs.

◆ DeleteFilesInDirectory() \[3/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteFilesInDirectory ( string remoteDirName,
bool noErrorIfNotExists )
inline

Deletes all files in a KiFS directory.

Parameters
remoteDirName Name of the KiFS directory containing files to delete.
noErrorIfNotExists Whether to suppress error if directory doesn't exist.

Definition at line 665 of file KineticaFileHandler.cs.

◆ DeleteFilesInDirectory() \[4/4]

void kinetica.FileSystem.KineticaFileHandler.DeleteFilesInDirectory ( string remoteDirName,
bool noErrorIfNotExists )
inline

Deletes all files in a KiFS directory.

Parameters
remoteDirName Name of the KiFS directory containing files to delete.
noErrorIfNotExists Whether to suppress error if directory doesn't exist.

Definition at line 665 of file KineticaFileHandler.cs.

◆ Download() \[1/8]

void kinetica.FileSystem.KineticaFileHandler.Download ( IList\< string > fileNames,
string localDirName )
inline

Downloads multiple files from KiFS to a local directory using default options.

Parameters
fileNames Paths of the KiFS files to download.
localDirName Path of the local directory to download to.

Definition at line 396 of file KineticaFileHandler.cs.

◆ Download() \[2/8]

void kinetica.FileSystem.KineticaFileHandler.Download ( IList\< string > fileNames,
string localDirName )
inline

Downloads multiple files from KiFS to a local directory using default options.

Parameters
fileNames Paths of the KiFS files to download.
localDirName Path of the local directory to download to.

Definition at line 396 of file KineticaFileHandler.cs.

◆ Download() \[3/8]

void kinetica.FileSystem.KineticaFileHandler.Download ( IList\< string > fileNames,
string localDirName,
DownloadOptions? downloadOptions,
IFileDownloadListener? callback )
inline

Downloads multiple files from KiFS to a local directory.

Parameters
fileNames Paths of the KiFS files to download.
localDirName Path of the local directory to download to.
downloadOptions Options for the download operation.
callback Optional callback for download progress notifications.

Definition at line 408 of file KineticaFileHandler.cs.

◆ Download() \[4/8]

void kinetica.FileSystem.KineticaFileHandler.Download ( IList\< string > fileNames,
string localDirName,
DownloadOptions? downloadOptions,
IFileDownloadListener? callback )
inline

Downloads multiple files from KiFS to a local directory.

Parameters
fileNames Paths of the KiFS files to download.
localDirName Path of the local directory to download to.
downloadOptions Options for the download operation.
callback Optional callback for download progress notifications.

Definition at line 408 of file KineticaFileHandler.cs.

◆ Download() \[5/8]

void kinetica.FileSystem.KineticaFileHandler.Download ( string fileName,
string localDirName )
inline

Downloads a single file from KiFS to a local directory using default options.

Parameters
fileName Path of the KiFS file to download.
localDirName Path of the local directory to download to.

Definition at line 374 of file KineticaFileHandler.cs.

◆ Download() \[6/8]

void kinetica.FileSystem.KineticaFileHandler.Download ( string fileName,
string localDirName )
inline

Downloads a single file from KiFS to a local directory using default options.

Parameters
fileName Path of the KiFS file to download.
localDirName Path of the local directory to download to.

Definition at line 374 of file KineticaFileHandler.cs.

◆ Download() \[7/8]

void kinetica.FileSystem.KineticaFileHandler.Download ( string fileName,
string localDirName,
DownloadOptions? downloadOptions,
IFileDownloadListener? callback )
inline

Downloads a single file from KiFS to a local directory.

Parameters
fileName Path of the KiFS file to download.
localDirName Path of the local directory to download to.
downloadOptions Options for the download operation.
callback Optional callback for download progress notifications.

Definition at line 386 of file KineticaFileHandler.cs.

◆ Download() \[8/8]

void kinetica.FileSystem.KineticaFileHandler.Download ( string fileName,
string localDirName,
DownloadOptions? downloadOptions,
IFileDownloadListener? callback )
inline

Downloads a single file from KiFS to a local directory.

Parameters
fileName Path of the KiFS file to download.
localDirName Path of the local directory to download to.
downloadOptions Options for the download operation.
callback Optional callback for download progress notifications.

Definition at line 386 of file KineticaFileHandler.cs.

◆ DownloadAsync() \[1/2]

async Task kinetica.FileSystem.KineticaFileHandler.DownloadAsync ( IList\< string > fileNames,
string localDirName,
DownloadOptions? downloadOptions = null,
IFileDownloadListener? callback = null )
inline

Downloads files asynchronously from KiFS to a local directory.

Parameters
fileNames Paths of the KiFS files to download.
localDirName Path of the local directory to download to.
downloadOptions Options for the download operation.
callback Optional callback for download progress notifications.

Definition at line 472 of file KineticaFileHandler.cs.

◆ DownloadAsync() \[2/2]

async Task kinetica.FileSystem.KineticaFileHandler.DownloadAsync ( IList\< string > fileNames,
string localDirName,
DownloadOptions? downloadOptions = null,
IFileDownloadListener? callback = null )
inline

Downloads files asynchronously from KiFS to a local directory.

Parameters
fileNames Paths of the KiFS files to download.
localDirName Path of the local directory to download to.
downloadOptions Options for the download operation.
callback Optional callback for download progress notifications.

Definition at line 472 of file KineticaFileHandler.cs.

◆ DownloadDirectory() \[1/2]

void kinetica.FileSystem.KineticaFileHandler.DownloadDirectory ( string remoteDirName,
string localDirName,
DownloadOptions? downloadOptions = null,
IFileDownloadListener? callback = null )
inline

Downloads all files in a KiFS directory to a local directory.

Parameters
remoteDirName Path of the KiFS directory to download.
localDirName Path of the local directory to download to.
downloadOptions Options for the download operation.
callback Optional callback for download progress notifications.

Definition at line 452 of file KineticaFileHandler.cs.

◆ DownloadDirectory() \[2/2]

void kinetica.FileSystem.KineticaFileHandler.DownloadDirectory ( string remoteDirName,
string localDirName,
DownloadOptions? downloadOptions = null,
IFileDownloadListener? callback = null )
inline

Downloads all files in a KiFS directory to a local directory.

Parameters
remoteDirName Path of the KiFS directory to download.
localDirName Path of the local directory to download to.
downloadOptions Options for the download operation.
callback Optional callback for download progress notifications.

Definition at line 452 of file KineticaFileHandler.cs.

◆ KifsDirectoriesExist() \[1/2]

bool kinetica.FileSystem.KineticaFileHandler.KifsDirectoriesExist ( ISet\< string > dirNames )
inline

Checks whether multiple KiFS directories exist.

Parameters
dirNames Set of full KiFS directory paths to check.
Returns
True if all directories exist, false otherwise.

Definition at line 729 of file KineticaFileHandler.cs.

◆ KifsDirectoriesExist() \[2/2]

bool kinetica.FileSystem.KineticaFileHandler.KifsDirectoriesExist ( ISet\< string > dirNames )
inline

Checks whether multiple KiFS directories exist.

Parameters
dirNames Set of full KiFS directory paths to check.
Returns
True if all directories exist, false otherwise.

Definition at line 729 of file KineticaFileHandler.cs.

◆ KifsDirectoryExists() \[1/2]

bool kinetica.FileSystem.KineticaFileHandler.KifsDirectoryExists ( string dirName )
inline

Checks whether a KiFS directory exists.

Parameters
dirName Full KiFS directory path to check.
Returns
True if the directory exists, false otherwise.

Definition at line 708 of file KineticaFileHandler.cs.

◆ KifsDirectoryExists() \[2/2]

bool kinetica.FileSystem.KineticaFileHandler.KifsDirectoryExists ( string dirName )
inline

Checks whether a KiFS directory exists.

Parameters
dirName Full KiFS directory path to check.
Returns
True if the directory exists, false otherwise.

Definition at line 708 of file KineticaFileHandler.cs.

◆ KifsFileExists() \[1/2]

bool kinetica.FileSystem.KineticaFileHandler.KifsFileExists ( string fileName )
inline

Checks whether a KiFS file exists.

Parameters
fileName Full KiFS file path to check.
Returns
True if the file exists, false otherwise.

Definition at line 751 of file KineticaFileHandler.cs.

◆ KifsFileExists() \[2/2]

bool kinetica.FileSystem.KineticaFileHandler.KifsFileExists ( string fileName )
inline

Checks whether a KiFS file exists.

Parameters
fileName Full KiFS file path to check.
Returns
True if the file exists, false otherwise.

Definition at line 751 of file KineticaFileHandler.cs.

◆ ShowAllDirectories() \[1/2]

IList\< KifsDirectoryInfo > kinetica.FileSystem.KineticaFileHandler.ShowAllDirectories ( )
inline

Returns statistics about all KiFS directories.

Returns
List of KifsDirectoryInfo objects.

Definition at line 602 of file KineticaFileHandler.cs.

◆ ShowAllDirectories() \[2/2]

IList\< KifsDirectoryInfo > kinetica.FileSystem.KineticaFileHandler.ShowAllDirectories ( )
inline

Returns statistics about all KiFS directories.

Returns
List of KifsDirectoryInfo objects.

Definition at line 602 of file KineticaFileHandler.cs.

◆ ShowDirectories() \[1/2]

IList\< KifsDirectoryInfo > kinetica.FileSystem.KineticaFileHandler.ShowDirectories ( IList\< string > remoteDirNames )
inline

Returns statistics about the given KiFS directories.

Parameters
remoteDirNames List of KiFS directory names.
Returns
List of KifsDirectoryInfo objects.

Definition at line 542 of file KineticaFileHandler.cs.

◆ ShowDirectories() \[2/2]

IList\< KifsDirectoryInfo > kinetica.FileSystem.KineticaFileHandler.ShowDirectories ( IList\< string > remoteDirNames )
inline

Returns statistics about the given KiFS directories.

Parameters
remoteDirNames List of KiFS directory names.
Returns
List of KifsDirectoryInfo objects.

Definition at line 542 of file KineticaFileHandler.cs.

◆ ShowDirectory() \[1/2]

IList\< KifsDirectoryInfo > kinetica.FileSystem.KineticaFileHandler.ShowDirectory ( string remoteDirName )
inline

Returns statistics about a single KiFS directory.

Parameters
remoteDirName Name of the KiFS directory.
Returns
List of KifsDirectoryInfo objects.

Definition at line 576 of file KineticaFileHandler.cs.

◆ ShowDirectory() \[2/2]

IList\< KifsDirectoryInfo > kinetica.FileSystem.KineticaFileHandler.ShowDirectory ( string remoteDirName )
inline

Returns statistics about a single KiFS directory.

Parameters
remoteDirName Name of the KiFS directory.
Returns
List of KifsDirectoryInfo objects.

Definition at line 576 of file KineticaFileHandler.cs.

◆ ShowFiles() \[1/2]

IList\< KifsFileInfo > kinetica.FileSystem.KineticaFileHandler.ShowFiles ( IList\< string > remotePaths )
inline

Returns statistics about the given KiFS files.

Parameters
remotePaths List of KiFS file or directory paths.
Returns
List of KifsFileInfo objects.

Definition at line 676 of file KineticaFileHandler.cs.

◆ ShowFiles() \[2/2]

IList\< KifsFileInfo > kinetica.FileSystem.KineticaFileHandler.ShowFiles ( IList\< string > remotePaths )
inline

Returns statistics about the given KiFS files.

Parameters
remotePaths List of KiFS file or directory paths.
Returns
List of KifsFileInfo objects.

Definition at line 676 of file KineticaFileHandler.cs.

◆ Upload() \[1/8]

void kinetica.FileSystem.KineticaFileHandler.Upload ( IList\< string > fileNames,
string remoteDirName )
inline

Uploads multiple files to a KiFS directory using default options.

Parameters
fileNames Names and paths of the local files (or glob patterns) to upload.
remoteDirName Name of the KiFS directory to upload to.

Definition at line 105 of file KineticaFileHandler.cs.

◆ Upload() \[2/8]

void kinetica.FileSystem.KineticaFileHandler.Upload ( IList\< string > fileNames,
string remoteDirName )
inline

Uploads multiple files to a KiFS directory using default options.

Parameters
fileNames Names and paths of the local files (or glob patterns) to upload.
remoteDirName Name of the KiFS directory to upload to.

Definition at line 105 of file KineticaFileHandler.cs.

◆ Upload() \[3/8]

void kinetica.FileSystem.KineticaFileHandler.Upload ( IList\< string > fileNames,
string remoteDirName,
UploadOptions? uploadOptions,
IFileUploadListener? callback )
inline

Uploads multiple files to a KiFS directory.

Parameters
fileNames Names and paths of the local files (or glob patterns) to upload.
remoteDirName Name of the KiFS directory to upload to.
uploadOptions Options for the upload operation.
callback Optional callback for upload progress notifications.

Definition at line 117 of file KineticaFileHandler.cs.

◆ Upload() \[4/8]

void kinetica.FileSystem.KineticaFileHandler.Upload ( IList\< string > fileNames,
string remoteDirName,
UploadOptions? uploadOptions,
IFileUploadListener? callback )
inline

Uploads multiple files to a KiFS directory.

Parameters
fileNames Names and paths of the local files (or glob patterns) to upload.
remoteDirName Name of the KiFS directory to upload to.
uploadOptions Options for the upload operation.
callback Optional callback for upload progress notifications.

Definition at line 117 of file KineticaFileHandler.cs.

◆ Upload() \[5/8]

void kinetica.FileSystem.KineticaFileHandler.Upload ( string fileName,
string remoteDirName )
inline

Uploads a single file to a KiFS directory using default options.

Parameters
fileName Name and path of the local file (or glob pattern) to upload.
remoteDirName Name of the KiFS directory to upload to.

Definition at line 83 of file KineticaFileHandler.cs.

◆ Upload() \[6/8]

void kinetica.FileSystem.KineticaFileHandler.Upload ( string fileName,
string remoteDirName )
inline

Uploads a single file to a KiFS directory using default options.

Parameters
fileName Name and path of the local file (or glob pattern) to upload.
remoteDirName Name of the KiFS directory to upload to.

Definition at line 83 of file KineticaFileHandler.cs.

◆ Upload() \[7/8]

void kinetica.FileSystem.KineticaFileHandler.Upload ( string fileName,
string remoteDirName,
UploadOptions? uploadOptions,
IFileUploadListener? callback )
inline

Uploads a single file to a KiFS directory.

Parameters
fileName Name and path of the local file (or glob pattern) to upload.
remoteDirName Name of the KiFS directory to upload to.
uploadOptions Options for the upload operation.
callback Optional callback for upload progress notifications.

Definition at line 95 of file KineticaFileHandler.cs.

◆ Upload() \[8/8]

void kinetica.FileSystem.KineticaFileHandler.Upload ( string fileName,
string remoteDirName,
UploadOptions? uploadOptions,
IFileUploadListener? callback )
inline

Uploads a single file to a KiFS directory.

Parameters
fileName Name and path of the local file (or glob pattern) to upload.
remoteDirName Name of the KiFS directory to upload to.
uploadOptions Options for the upload operation.
callback Optional callback for upload progress notifications.

Definition at line 95 of file KineticaFileHandler.cs.

◆ UploadAsync() \[1/2]

async Task kinetica.FileSystem.KineticaFileHandler.UploadAsync ( IList\< string > fileNames,
string remoteDirName,
UploadOptions? uploadOptions = null,
IFileUploadListener? callback = null )
inline

Uploads files asynchronously to a KiFS directory.

Parameters
fileNames Names and paths of the local files (or glob patterns) to upload.
remoteDirName Name of the KiFS directory to upload to.
uploadOptions Options for the upload operation.
callback Optional callback for upload progress notifications.

Definition at line 183 of file KineticaFileHandler.cs.

◆ UploadAsync() \[2/2]

async Task kinetica.FileSystem.KineticaFileHandler.UploadAsync ( IList\< string > fileNames,
string remoteDirName,
UploadOptions? uploadOptions = null,
IFileUploadListener? callback = null )
inline

Uploads files asynchronously to a KiFS directory.

Parameters
fileNames Names and paths of the local files (or glob patterns) to upload.
remoteDirName Name of the KiFS directory to upload to.
uploadOptions Options for the upload operation.
callback Optional callback for upload progress notifications.

Definition at line 183 of file KineticaFileHandler.cs.

Member Data Documentation

◆ DefaultFileSizeToSplit

const long kinetica.FileSystem.KineticaFileHandler.DefaultFileSizeToSplit = 62914560
static

Default file size threshold for multi-part uploads (60 MB).

Files larger than this will be uploaded in parts.

Definition at line 42 of file KineticaFileHandler.cs.

◆ DefaultThreadPoolSize

const int kinetica.FileSystem.KineticaFileHandler.DefaultThreadPoolSize = 5
static

Default thread pool size for file operations.

Definition at line 47 of file KineticaFileHandler.cs.

◆ KifsPathPrefix

const string kinetica.FileSystem.KineticaFileHandler.KifsPathPrefix = "kifs\://"
static

Prefix to use when referencing KiFS files (e.g., for file ingest).

Definition at line 31 of file KineticaFileHandler.cs.

◆ KifsPathSeparator

const string kinetica.FileSystem.KineticaFileHandler.KifsPathSeparator = "/"
static

Separator character between a KiFS directory and file name.

Definition at line 26 of file KineticaFileHandler.cs.

◆ RemoteUserHomeDirPrefix

const string kinetica.FileSystem.KineticaFileHandler.RemoteUserHomeDirPrefix = "\~"
static

Alias for a user's home directory.

Definition at line 36 of file KineticaFileHandler.cs.

Property Documentation

◆ FileHandlerOptions

Options kinetica.FileSystem.KineticaFileHandler.FileHandlerOptions
get

Gets the options for this file handler.

Definition at line 74 of file KineticaFileHandler.cs.

The documentation for this class was generated from the following files: