Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
ExportRecordsToFiles.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 
10 
11 namespace kinetica
12 {
13 
39  {
40 
301  public struct Options
302  {
303 
306  public const string BATCH_SIZE = "batch_size";
307 
320  public const string COLUMN_FORMATS = "column_formats";
321 
341  public const string COLUMNS_TO_EXPORT = "columns_to_export";
342 
350  public const string COLUMNS_TO_SKIP = "columns_to_skip";
351 
355  public const string DATASINK_NAME = "datasink_name";
356 
390  public const string DEFAULT_COLUMN_FORMATS = "default_column_formats";
391 
394  public const string EXPORT_DDL = "export_ddl";
395 
398  public const string FILE_EXTENSION = "file_extension";
399 
416  public const string FILE_TYPE = "file_type";
417 
420  public const string DELIMITED_TEXT = "delimited_text";
421  public const string PARQUET = "parquet";
422 
440  public const string KINETICA_HEADER = "kinetica_header";
441  public const string TRUE = "true";
442  public const string FALSE = "false";
443 
448  public const string KINETICA_HEADER_DELIMITER = "kinetica_header_delimiter";
449 
468  public const string COMPRESSION_TYPE = "compression_type";
469  public const string UNCOMPRESSED = "uncompressed";
470  public const string SNAPPY = "snappy";
471  public const string GZIP = "gzip";
472 
494  public const string SINGLE_FILE = "single_file";
495  public const string OVERWRITE = "overwrite";
496 
500  public const string SINGLE_FILE_MAX_SIZE = "single_file_max_size";
501 
508  public const string TEXT_DELIMITER = "text_delimiter";
509 
526  public const string TEXT_HAS_HEADER = "text_has_header";
527 
534  public const string TEXT_NULL_STRING = "text_null_string";
535  } // end struct Options
536 
537  public string table_name { get; set; }
538 
552  public string filepath { get; set; }
553 
812  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
813 
814 
818 
1087  string filepath,
1088  IDictionary<string, string> options = null)
1089  {
1090  this.table_name = table_name ?? "";
1091  this.filepath = filepath ?? "";
1092  this.options = options ?? new Dictionary<string, string>();
1093  } // end constructor
1094 
1095  } // end class ExportRecordsToFilesRequest
1096 
1097 
1098 
1103  {
1104 
1106  public string table_name { get; set; }
1107 
1109  public long count_exported { get; set; }
1110 
1112  public long count_skipped { get; set; }
1113 
1115  public IList<string> files { get; set; } = new List<string>();
1116 
1118  public long last_timestamp { get; set; }
1119  public IList<string> data_text { get; set; } = new List<string>();
1120  public IList<byte[]> data_bytes { get; set; } = new List<byte[]>();
1121 
1123  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1124 
1125  } // end class ExportRecordsToFilesResponse
1126 
1127 
1128 
1129 
1130 } // end namespace kinetica
IDictionary< string, string > info
Additional information
const string COLUMN_FORMATS
For each source column specified, applies the column-property-bound format.
string filepath
Path to data export target.
const string DEFAULT_COLUMN_FORMATS
Specifies the default format to use to write data.
const string EXPORT_DDL
Save DDL to a separate file.
const string TEXT_DELIMITER
Specifies the character to write out to delimit field values and field names in the header (if presen...
const string COLUMNS_TO_SKIP
Comma-separated list of column names or column numbers to not export.
ExportRecordsToFilesRequest(string table_name, string filepath, IDictionary< string, string > options=null)
Constructs an ExportRecordsToFilesRequest object with the specified parameters.
A set of results returned by Kinetica.exportRecordsToFiles(string,string,IDictionary{string, string}).
const string SINGLE_FILE
Save records to a single file.
ExportRecordsToFilesRequest()
Constructs an ExportRecordsToFilesRequest object with default parameters.
long count_exported
Number of source table records exported
const string COLUMNS_TO_EXPORT
Specifies a comma-delimited list of columns from the source table to export, written to the output fi...
const string BATCH_SIZE
Number of records to be exported as a batch.
A set of parameters for Kinetica.exportRecordsToFiles(string,string,IDictionary{string, string}).
const string COMPRESSION_TYPE
File compression type.
const string SINGLE_FILE_MAX_SIZE
Max file size (in MB) to allow saving to a single file.
long last_timestamp
Timestamp of last file scanned
IDictionary< string, string > options
Optional parameters.
const string TEXT_HAS_HEADER
Indicates whether to write out a header row.
const string FILE_EXTENSION
Extension to give the export file.
long count_skipped
Number of source table records skipped
const string KINETICA_HEADER
Whether to include a Kinetica proprietary header.
const string TEXT_NULL_STRING
Specifies the character string that should be written out for the null value in the data...
const string FILE_TYPE
Specifies the file format to use when exporting data.
const string KINETICA_HEADER_DELIMITER
If a Kinetica proprietary header is included, then specify a property separator.
const string DELIMITED_TEXT
Delimited text file format; e.g., CSV, TSV, PSV, etc.
const string DATASINK_NAME
Datasink name, created using Kinetica.createDatasink(string,string,IDictionary{string, string}).
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IList< string > files
Names of all exported files