Skip to main content

​
◆ filterByTable() [1/2]

FilterByTableResponse kinetica.Kinetica.filterByTable (FilterByTableRequestrequest_)
 inline

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 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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 39484 of file KineticaFunctions.cs.

​
◆ filterByTable() [2/2]

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

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 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.

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 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.
Returns
Response object containing the result of the operation.

Definition at line 39719 of file KineticaFunctions.cs.

​
◆ FilterByTableAsync() [1/2]

async System.Threading.Tasks.Task< FilterByTableResponse > kinetica.Kinetica.FilterByTableAsync (FilterByTableRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Filters objects in one table based on objects in another table.

(async)

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 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.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 39510 of file KineticaFunctions.cs.

​
◆ FilterByTableAsync() [2/2]

async System.Threading.Tasks.Task< FilterByTableResponse > kinetica.Kinetica.FilterByTableAsync (stringtable_name,
stringview_name,
stringcolumn_name,
stringsource_table_name,
stringsource_table_column_name,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Filters objects in one table based on objects in another table.

(async)

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 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.

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 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 39934 of file KineticaFunctions.cs.