Kinetica   C#   API  Version 7.2.3.1
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 namespace kinetica;
10 
31 {
35  public struct Options
36  {
39  public const string BATCH_SIZE = "batch_size";
40 
52  public const string COLUMN_FORMATS = "column_formats";
53 
70  public const string COLUMNS_TO_EXPORT = "columns_to_export";
71 
79  public const string COLUMNS_TO_SKIP = "columns_to_skip";
80 
84  public const string DATASINK_NAME = "datasink_name";
85 
113  public const string DEFAULT_COLUMN_FORMATS = "default_column_formats";
114 
117  public const string EXPORT_DDL = "export_ddl";
118 
121  public const string FILE_EXTENSION = "file_extension";
122 
140  public const string FILE_TYPE = "file_type";
141 
144  public const string DELIMITED_TEXT = "delimited_text";
145 
146  public const string PARQUET = "parquet";
147 
161  public const string KINETICA_HEADER = "kinetica_header";
162 
163  public const string TRUE = "true";
164  public const string FALSE = "false";
165 
170  public const string KINETICA_HEADER_DELIMITER = "kinetica_header_delimiter";
171 
186  public const string COMPRESSION_TYPE = "compression_type";
187 
188  public const string UNCOMPRESSED = "uncompressed";
189  public const string SNAPPY = "snappy";
190  public const string GZIP = "gzip";
191 
207  public const string SINGLE_FILE = "single_file";
208 
209  public const string OVERWRITE = "overwrite";
210 
215  public const string SINGLE_FILE_MAX_SIZE = "single_file_max_size";
216 
223  public const string TEXT_DELIMITER = "text_delimiter";
224 
237  public const string TEXT_HAS_HEADER = "text_has_header";
238 
245  public const string TEXT_NULL_STRING = "text_null_string";
246  } // end struct Options
247 
248  public string table_name { get; set; }
249 
259  public string filepath { get; set; }
260 
496  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
497 
501 
751  string filepath,
752  IDictionary<string, string> options = null)
753  {
754  this.table_name = table_name ?? "";
755  this.filepath = filepath ?? "";
756  this.options = options ?? new Dictionary<string, string>();
757  } // end constructor
758 } // end class ExportRecordsToFilesRequest
759 
764 {
766  public string table_name { get; set; }
767 
769  public long count_exported { get; set; }
770 
772  public long count_skipped { get; set; }
773 
775  public IList<string> files { get; set; } = new List<string>();
776 
778  public long last_timestamp { get; set; }
779 
780  public IList<string> data_text { get; set; } = new List<string>();
781 
782  public IList<byte[]> data_bytes { get; set; } = new List<byte[]>();
783 
785  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
786 } // end class ExportRecordsToFilesResponse
long count_skipped
Number of source table records skipped.
const string KINETICA_HEADER
Whether to include a Kinetica proprietary header.
const string TEXT_HAS_HEADER
Indicates whether to write out a header row.
const string EXPORT_DDL
Save DDL to a separate file.
const string COLUMNS_TO_EXPORT
Specifies a comma-delimited list of columns from the source table to export, written to the output fi...
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string COLUMN_FORMATS
For each source column specified, applies the column-property-bound format.
const string DEFAULT_COLUMN_FORMATS
Specifies the default format to use to write data.
ExportRecordsToFilesRequest(string table_name, string filepath, IDictionary< string, string > options=null)
Constructs an ExportRecordsToFilesRequest object with the specified parameters.
const string DATASINK_NAME
Datasink name, created using Kinetica.createDatasink.
const string SINGLE_FILE
Save records to a single file.
const string COMPRESSION_TYPE
File compression type.
const string TEXT_NULL_STRING
Specifies the character string that should be written out for the null value in the data.
long last_timestamp
Timestamp of last file scanned.
const string FILE_TYPE
Specifies the file format to use when exporting data.
IDictionary< string, string > options
Optional parameters.
A set of parameters for Kinetica.exportRecordsToFiles.
const string FILE_EXTENSION
Extension to give the export file.
IDictionary< string, string > info
Additional information.
const string KINETICA_HEADER_DELIMITER
If a Kinetica proprietary header is included, then specify a property separator.
const string TEXT_DELIMITER
Specifies the character to write out to delimit field values and field names in the header (if presen...
IList< string > files
Names of all exported files.
A set of string constants for the parameter options.
ExportRecordsToFilesRequest()
Constructs an ExportRecordsToFilesRequest object with default parameters.
string table_name
Name of source table.
const string SINGLE_FILE_MAX_SIZE
Max file size (in MB) to allow saving to a single file.
A set of results returned by Kinetica.exportRecordsToFiles.
const string COLUMNS_TO_SKIP
Comma-separated list of column names or column numbers to not export.
long count_exported
Number of source table records exported.
string filepath
Path to data export target.
const string BATCH_SIZE
Number of records to be exported as a batch.
const string DELIMITED_TEXT
Delimited text file format; e.g., CSV, TSV, PSV, etc.