A set of parameters for Kinetica.filter. More…
Inheritance diagram for kinetica.FilterRequest:
[legend]
Collaboration diagram for kinetica.FilterRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter FilterRequest.options. More… | |
Public Member Functions | |
| FilterRequest () | |
| Constructs a FilterRequest object with default parameters. | |
| FilterRequest (string table_name, string view_name, string expression, IDictionary< string, string > options=null) | |
| Constructs a FilterRequest object with the specified parameters. | |
| FilterRequest () | |
| Constructs a FilterRequest object with default parameters. | |
| FilterRequest (string table_name, string view_name, string expression, IDictionary< string, string > options=null) | |
| Constructs a FilterRequest 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 to filter, 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 | expression [get, set] |
| The select expression to filter the specified table. | |
| 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.filter.
Filters data based on the specified expression. The results are stored in a result set with the given FilterRequest.view_name.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
Constructor & Destructor Documentation
◆ FilterRequest() [1/4]
| inline |
Constructs a FilterRequest object with default parameters.
◆ FilterRequest() [2/4]
| inline |
Constructs a FilterRequest object with the specified parameters.
Parameters
| table_name | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| view_name | 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 ”. |
| expression | The select expression to filter the specified table. For details see Expressions. |
| options | Optional parameters.
|
◆ FilterRequest() [3/4]
| inline |
Constructs a FilterRequest object with default parameters.
◆ FilterRequest() [4/4]
| inline |
Constructs a FilterRequest object with the specified parameters.
Parameters
| table_name | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| view_name | 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 ”. |
| expression | The select expression to filter the specified table. For details see Expressions. |
| options | Optional parameters.
|
Property Documentation
◆ expression
| getset |
The select expression to filter the specified table.
For details see Expressions.
◆ options
| getset |
Optional parameters.
- CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of FilterRequest.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 FilterRequest.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.
- VIEW_ID: View this filtered-view is part of. The default value is ”.
- TTL: Sets the TTL of the view specified in FilterRequest.view_name.
The default value is an empty Dictionary.
◆ table_name
| getset |
Name of the table to filter, in [schema_name.
]table_name format, using standard name resolution rules.
This may be the name of a table or a view (when chaining queries).
◆ 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 ”.
The documentation for this class was generated from the following files: