Kinetica   C#   API  Version 7.2.3.1
FilterByTableRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes

const string CREATE_TEMP_TABLE = "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. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string COLLECTION_NAME = "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. More...
 
const string FILTER_MODE = "filter_mode"
 String indicating the filter mode, either IN_TABLE or NOT_IN_TABLE. More...
 
const string IN_TABLE = "in_table"
 
const string NOT_IN_TABLE = "not_in_table"
 
const string MODE = "mode"
 Mode - should be either SPATIAL or NORMAL. More...
 
const string NORMAL = "normal"
 
const string SPATIAL = "spatial"
 
const string BUFFER = "buffer"
 Buffer size, in meters. More...
 
const string BUFFER_METHOD = "buffer_method"
 Method used to buffer polygons. More...
 
const string GEOS = "geos"
 Use geos 1 edge per corner algorithm. More...
 
const string MAX_PARTITION_SIZE = "max_partition_size"
 Maximum number of points in a partition. More...
 
const string MAX_PARTITION_SCORE = "max_partition_score"
 Maximum number of points * edges in a partition. More...
 
const string X_COLUMN_NAME = "x_column_name"
 Name of column containing x value of point being filtered in SPATIAL mode. More...
 
const string Y_COLUMN_NAME = "y_column_name"
 Name of column containing y value of point being filtered in SPATIAL mode. More...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 28 of file FilterByTable.cs.

Member Data Documentation

◆ BUFFER

const string FilterByTableRequest.Options.BUFFER = "buffer"

Buffer size, in meters.

Only relevant for SPATIAL mode. The default value is '0'.

Definition at line 101 of file FilterByTable.cs.

◆ BUFFER_METHOD

const string FilterByTableRequest.Options.BUFFER_METHOD = "buffer_method"

Method used to buffer polygons.

Supported values:

  • NORMAL
  • GEOS: Use geos 1 edge per corner algorithm.

The default value is NORMAL.

Definition at line 117 of file FilterByTable.cs.

◆ COLLECTION_NAME

const string FilterByTableRequest.Options.COLLECTION_NAME = "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.

Definition at line 56 of file FilterByTable.cs.

◆ CREATE_TEMP_TABLE

const string FilterByTableRequest.Options.CREATE_TEMP_TABLE = "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.

Supported values:

The default value is FALSE.

Definition at line 44 of file FilterByTable.cs.

◆ FALSE

const string FilterByTableRequest.Options.FALSE = "false"

Definition at line 47 of file FilterByTable.cs.

◆ FILTER_MODE

const string FilterByTableRequest.Options.FILTER_MODE = "filter_mode"

String indicating the filter mode, either IN_TABLE or NOT_IN_TABLE.

Supported values:

The default value is IN_TABLE.

Definition at line 73 of file FilterByTable.cs.

◆ GEOS

const string FilterByTableRequest.Options.GEOS = "geos"

Use geos 1 edge per corner algorithm.

Definition at line 120 of file FilterByTable.cs.

◆ IN_TABLE

const string FilterByTableRequest.Options.IN_TABLE = "in_table"

Definition at line 75 of file FilterByTable.cs.

◆ MAX_PARTITION_SCORE

const string FilterByTableRequest.Options.MAX_PARTITION_SCORE = "max_partition_score"

Maximum number of points * edges in a partition.

Only relevant for SPATIAL mode. The default value is '8000000'.

Definition at line 132 of file FilterByTable.cs.

◆ MAX_PARTITION_SIZE

const string FilterByTableRequest.Options.MAX_PARTITION_SIZE = "max_partition_size"

Maximum number of points in a partition.

Only relevant for SPATIAL mode. The default value is '0'.

Definition at line 126 of file FilterByTable.cs.

◆ MODE

const string FilterByTableRequest.Options.MODE = "mode"

Mode - should be either SPATIAL or NORMAL.

Supported values:

The default value is NORMAL.

Definition at line 92 of file FilterByTable.cs.

◆ NORMAL

const string FilterByTableRequest.Options.NORMAL = "normal"

Definition at line 94 of file FilterByTable.cs.

◆ NOT_IN_TABLE

const string FilterByTableRequest.Options.NOT_IN_TABLE = "not_in_table"

Definition at line 76 of file FilterByTable.cs.

◆ SPATIAL

const string FilterByTableRequest.Options.SPATIAL = "spatial"

Definition at line 95 of file FilterByTable.cs.

◆ TRUE

const string FilterByTableRequest.Options.TRUE = "true"

Definition at line 46 of file FilterByTable.cs.

◆ X_COLUMN_NAME

const string FilterByTableRequest.Options.X_COLUMN_NAME = "x_column_name"

Name of column containing x value of point being filtered in SPATIAL mode.

The default value is 'x'.

Definition at line 137 of file FilterByTable.cs.

◆ Y_COLUMN_NAME

const string FilterByTableRequest.Options.Y_COLUMN_NAME = "y_column_name"

Name of column containing y value of point being filtered in SPATIAL mode.

The default value is 'y'.

Definition at line 142 of file FilterByTable.cs.


The documentation for this struct was generated from the following file: