Skip to main content

A set of parameters for Kinetica.filterByTable. More…

Inheritance diagram for kinetica.FilterByTableRequest:
[legend]
Collaboration diagram for kinetica.FilterByTableRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter FilterByTableRequest.options. More…
 

​
Public Member Functions

 FilterByTableRequest ()
 Constructs a FilterByTableRequest object with default parameters.
 
 FilterByTableRequest (string table_name, string view_name, string column_name, string source_table_name, string source_table_column_name, IDictionary< string, string > options=null)
 Constructs a FilterByTableRequest object with the specified parameters.
 
 FilterByTableRequest ()
 Constructs a FilterByTableRequest object with default parameters.
 
 FilterByTableRequest (string table_name, string view_name, string column_name, string source_table_name, string source_table_column_name, IDictionary< string, string > options=null)
 Constructs a FilterByTableRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

string table_name [get, set]
 Name of the table whose data will be filtered, in [schema_name.
 
string view_name = "" [get, set]
 If provided, then this will be the name of the view containing the results, in [schema_name.
 
string column_name [get, set]
 Name of the column by whose value the data will be filtered from the table designated by FilterByTableRequest.table_name.
 
string source_table_name [get, set]
 Name of the table whose data will be compared against in the table called FilterByTableRequest.table_name, in [schema_name.
 
string source_table_column_name [get, set]
 Name of the column in the FilterByTableRequest.source_table_name whose values will be used as the filter for table FilterByTableRequest.table_name.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.filterByTable.

Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a FilterByTableRequest.view_name is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Definition at line 24 of file FilterByTable.cs.

​
Constructor & Destructor Documentation

​
◆ FilterByTableRequest() [1/4]

kinetica.FilterByTableRequest.FilterByTableRequest ()
 inline

Constructs a FilterByTableRequest object with default parameters.

Definition at line 395 of file FilterByTable.cs.

​
◆ FilterByTableRequest() [2/4]

kinetica.FilterByTableRequest.FilterByTableRequest (stringtable_name,
stringview_name,
stringcolumn_name,
stringsource_table_name,
stringsource_table_column_name,
IDictionary< string, string >options = null )
 inline

Constructs a FilterByTableRequest object with the specified parameters.

Parameters
table_nameName of the table whose data will be filtered, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
view_nameIf provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ”.
column_nameName of the column by whose value the data will be filtered from the table designated by table_name .
source_table_nameName of the table whose data will be compared against in the table called table_name , in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
source_table_column_nameName of the column in the source_table_name whose values will be used as the filter for table table_name . Must be a geospatial geometry column if in ‘spatial’ mode; otherwise, Must match the type of the column_name .
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of view_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_VIEW_NAME. Supported values:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • FILTER_MODE: String indicating the filter mode, either IN_TABLE or NOT_IN_TABLE. Supported values:The default value is IN_TABLE.
  • MODE: Mode - should be either SPATIAL or NORMAL. Supported values:The default value is NORMAL.
  • BUFFER: Buffer size, in meters. Only relevant for SPATIAL mode. The default value is ‘0’.
  • BUFFER_METHOD: Method used to buffer polygons. Only relevant for SPATIAL mode. Supported values:
    • NORMAL
    • GEOS: Use geos 1 edge per corner algorithm.
    The default value is NORMAL.
  • MAX_PARTITION_SIZE: Maximum number of points in a partition. Only relevant for SPATIAL mode. The default value is ‘0’.
  • MAX_PARTITION_SCORE: Maximum number of points * edges in a partition. Only relevant for SPATIAL mode. The default value is ‘8000000’.
  • X_COLUMN_NAME: Name of column containing x value of point being filtered in SPATIAL mode. The default value is ‘x’.
  • Y_COLUMN_NAME: Name of column containing y value of point being filtered in SPATIAL mode. The default value is ‘y’.
The default value is an empty Dictionary.

Definition at line 587 of file FilterByTable.cs.

​
◆ FilterByTableRequest() [3/4]

kinetica.FilterByTableRequest.FilterByTableRequest ()
 inline

Constructs a FilterByTableRequest object with default parameters.

Definition at line 395 of file FilterByTable.cs.

​
◆ FilterByTableRequest() [4/4]

kinetica.FilterByTableRequest.FilterByTableRequest (stringtable_name,
stringview_name,
stringcolumn_name,
stringsource_table_name,
stringsource_table_column_name,
IDictionary< string, string >options = null )
 inline

Constructs a FilterByTableRequest object with the specified parameters.

Parameters
table_nameName of the table whose data will be filtered, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
view_nameIf provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ”.
column_nameName of the column by whose value the data will be filtered from the table designated by table_name .
source_table_nameName of the table whose data will be compared against in the table called table_name , in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
source_table_column_nameName of the column in the source_table_name whose values will be used as the filter for table table_name . Must be a geospatial geometry column if in ‘spatial’ mode; otherwise, Must match the type of the column_name .
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of view_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_VIEW_NAME. Supported values:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
  • FILTER_MODE: String indicating the filter mode, either IN_TABLE or NOT_IN_TABLE. Supported values:The default value is IN_TABLE.
  • MODE: Mode - should be either SPATIAL or NORMAL. Supported values:The default value is NORMAL.
  • BUFFER: Buffer size, in meters. Only relevant for SPATIAL mode. The default value is ‘0’.
  • BUFFER_METHOD: Method used to buffer polygons. Only relevant for SPATIAL mode. Supported values:
    • NORMAL
    • GEOS: Use geos 1 edge per corner algorithm.
    The default value is NORMAL.
  • MAX_PARTITION_SIZE: Maximum number of points in a partition. Only relevant for SPATIAL mode. The default value is ‘0’.
  • MAX_PARTITION_SCORE: Maximum number of points * edges in a partition. Only relevant for SPATIAL mode. The default value is ‘8000000’.
  • X_COLUMN_NAME: Name of column containing x value of point being filtered in SPATIAL mode. The default value is ‘x’.
  • Y_COLUMN_NAME: Name of column containing y value of point being filtered in SPATIAL mode. The default value is ‘y’.
The default value is an empty Dictionary.

Definition at line 587 of file FilterByTable.cs.

​
Property Documentation

​
◆ column_name

string kinetica.FilterByTableRequest.column_name
 getset

Name of the column by whose value the data will be filtered from the table designated by FilterByTableRequest.table_name.

Definition at line 210 of file FilterByTable.cs.

​
◆ options

IDictionary< string, string > kinetica.FilterByTableRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 391 of file FilterByTable.cs.

​
◆ source_table_column_name

string kinetica.FilterByTableRequest.source_table_column_name
 getset

Name of the column in the FilterByTableRequest.source_table_name whose values will be used as the filter for table FilterByTableRequest.table_name.

Must be a geospatial geometry column if in ‘spatial’ mode; otherwise, Must match the type of the FilterByTableRequest.column_name.

Definition at line 227 of file FilterByTable.cs.

​
◆ source_table_name

string kinetica.FilterByTableRequest.source_table_name
 getset

Name of the table whose data will be compared against in the table called FilterByTableRequest.table_name, in [schema_name.

]table_name format, using standard name resolution rules.

Must be an existing table.

Definition at line 218 of file FilterByTable.cs.

​
◆ table_name

string kinetica.FilterByTableRequest.table_name
 getset

Name of the table whose data will be filtered, in [schema_name.

]table_name format, using standard name resolution rules.

Must be an existing table.

Definition at line 195 of file FilterByTable.cs.

​
◆ view_name

string kinetica.FilterByTableRequest.view_name = ""
 getset

If provided, then this will be the name of the view containing the results, in [schema_name.

]view_name format, using standard name resolution rules and meeting table naming criteria.

Must not be an already existing table or view. The default value is ”.

Definition at line 205 of file FilterByTable.cs.

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