Note
This documentation is for a prior release of Kinetica. For the latest documentation, click here.
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 input parameter 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.
Input Parameter Description
Name | Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
table_name | string | 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. | ||||||||||||||||||||||||||||
view_name | string | 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 ''. | ||||||||||||||||||||||||||||
column_name | string | Name of the column by whose value the data will be filtered from the table designated by input parameter table_name. | ||||||||||||||||||||||||||||
source_table_name | string | Name of the table whose data will be compared against in the table called input parameter table_name, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. | ||||||||||||||||||||||||||||
source_table_column_name | string | Name of the column in the input parameter source_table_name whose values will be used as the filter for table input parameter table_name. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the input parameter column_name. | ||||||||||||||||||||||||||||
options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
Output Parameter Description
Name | Type | Description | ||||
---|---|---|---|---|---|---|
count | long | The number of records in input parameter table_name that have input parameter column_name values matching input parameter source_table_column_name values in input parameter source_table_name. | ||||
info | map of string to strings | Additional information. The default value is an empty map ( {} ).
|