kinetica.FilterByTableRequest.Options Struct Reference

Optional parameters. More...

Public Attributes
const string	COLLECTION_NAME = "collection_name"
	Name of a collection which is to contain 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

Optional parameters.

• COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
• FILTER_MODE: String indicating the filter mode, either in_table or not_in_table. Supported values:
  • IN_TABLE
  • NOT_IN_TABLE
  The default value is IN_TABLE.
• MODE: Mode - should be either spatial or normal. Supported values:
  • NORMAL
  • SPATIAL
  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. A set of string constants for the parameter options.

Definition at line 138 of file FilterByTable.cs.

Member Data Documentation

const string kinetica.FilterByTableRequest.Options.BUFFER = "buffer"

Buffer size, in meters.

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

Definition at line 187 of file FilterByTable.cs.

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

Definition at line 206 of file FilterByTable.cs.

const string kinetica.FilterByTableRequest.Options.COLLECTION_NAME = "collection_name"

Name of a collection which is to contain the newly created view.

If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.

Definition at line 145 of file FilterByTable.cs.

const string kinetica.FilterByTableRequest.Options.FILTER_MODE = "filter_mode"

String indicating the filter mode, either in_table or not_in_table.

Supported values:

• IN_TABLE
• NOT_IN_TABLE

The default value is IN_TABLE.

Definition at line 162 of file FilterByTable.cs.

const string kinetica.FilterByTableRequest.Options.GEOS = "geos"

Use geos 1 edge per corner algorithm

Definition at line 209 of file FilterByTable.cs.

const string kinetica.FilterByTableRequest.Options.IN_TABLE = "in_table"

Definition at line 163 of file FilterByTable.cs.

const string kinetica.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 218 of file FilterByTable.cs.

const string kinetica.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 213 of file FilterByTable.cs.

const string kinetica.FilterByTableRequest.Options.MODE = "mode"

Mode - should be either spatial or normal.

Supported values:

• NORMAL
• SPATIAL

The default value is NORMAL.

Definition at line 181 of file FilterByTable.cs.

const string kinetica.FilterByTableRequest.Options.NORMAL = "normal"

Definition at line 182 of file FilterByTable.cs.

const string kinetica.FilterByTableRequest.Options.NOT_IN_TABLE = "not_in_table"

Definition at line 164 of file FilterByTable.cs.

const string kinetica.FilterByTableRequest.Options.SPATIAL = "spatial"

Definition at line 183 of file FilterByTable.cs.

const string kinetica.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 223 of file FilterByTable.cs.

const string kinetica.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 228 of file FilterByTable.cs.

---

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

• Kinetica/Protocol/FilterByTable.cs