Optional parameters. More...

Public Attributes
const string	COLLECTION_NAME = "collection_name"
	[DEPRECATED–please specify the containing schema for the materialized view as part of table_name and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Name of a schema which is to contain the newly created view. More...

const string	EXECUTE_AS = "execute_as"
	User name to use to run the refresh job More...

const string	PERSIST = "persist"
	If true, then the materialized view specified in table_name will be persisted and will not expire unless a ttl is specified. More...

const string	TRUE = "true"

const string	FALSE = "false"

const string	REFRESH_SPAN = "refresh_span"
	Sets the future time-offset(in seconds) at which periodic refresh stops More...

const string	REFRESH_STOP_TIME = "refresh_stop_time"
	When refresh_method is periodic, specifies the time at which a periodic refresh is stopped. More...

const string	REFRESH_METHOD = "refresh_method"
	Method by which the join can be refreshed when the data in underlying member tables have changed. More...

const string	MANUAL = "manual"
	Refresh only occurs when manually requested by calling Kinetica.alterTable(string,string,string,IDictionary{string, string}) with an 'action' of 'refresh' More...

const string	ON_QUERY = "on_query"
	Refresh any time the view is queried. More...

const string	ON_CHANGE = "on_change"
	If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. More...

const string	PERIODIC = "periodic"
	Refresh table periodically at rate specified by refresh_period More...

const string	REFRESH_PERIOD = "refresh_period"
	When refresh_method is periodic, specifies the period in seconds at which refresh occurs More...

const string	REFRESH_START_TIME = "refresh_start_time"
	When refresh_method is periodic, specifies the first time at which a refresh is to be done. More...

const string	TTL = "ttl"
	Sets the TTL of the table specified in table_name. More...

Detailed Description

Optional parameters.

COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the materialized view as part of and use /create/schema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema provided is non-existent, it will be automatically created.
EXECUTE_AS: User name to use to run the refresh job
PERSIST: If true, then the materialized view specified in will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
- TRUE
- FALSE
The default value is FALSE.
REFRESH_SPAN: Sets the future time-offset(in seconds) at which periodic refresh stops
REFRESH_STOP_TIME: When refresh_method is periodic, specifies the time at which a periodic refresh is stopped. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
REFRESH_METHOD: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
- MANUAL: Refresh only occurs when manually requested by calling /alter/table with an 'action' of 'refresh'
- ON_QUERY: Refresh any time the view is queried.
- ON_CHANGE: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
- PERIODIC: Refresh table periodically at rate specified by refresh_period
The default value is MANUAL.
REFRESH_PERIOD: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
REFRESH_START_TIME: When refresh_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
TTL: Sets the TTL of the table specified in .

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 153 of file CreateMaterializedView.cs.

Member Data Documentation

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

[DEPRECATED–please specify the containing schema for the materialized view as part of table_name and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Name of a schema which is to contain the newly created view.

If the schema provided is non-existent, it will be automatically created.

Definition at line 164 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.EXECUTE_AS = "execute_as"

User name to use to run the refresh job

Definition at line 167 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.FALSE = "false"

Definition at line 189 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.MANUAL = "manual"

Refresh only occurs when manually requested by calling Kinetica.alterTable(string,string,string,IDictionary{string, string}) with an 'action' of 'refresh'

Definition at line 242 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.ON_CHANGE = "on_change"

If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done.

A full refresh is done if an incremental refresh is not possible.

Definition at line 251 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.ON_QUERY = "on_query"

Refresh any time the view is queried.

Definition at line 245 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.PERIODIC = "periodic"

Refresh table periodically at rate specified by refresh_period

Definition at line 255 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.PERSIST = "persist"

If true, then the materialized view specified in table_name will be persisted and will not expire unless a ttl is specified.

If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 187 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.REFRESH_METHOD = "refresh_method"

Method by which the join can be refreshed when the data in underlying member tables have changed.

Supported values:

MANUAL: Refresh only occurs when manually requested by calling Kinetica.alterTable(string,string,string,IDictionary{string, string}) with an 'action' of 'refresh'
ON_QUERY: Refresh any time the view is queried.
ON_CHANGE: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
PERIODIC: Refresh table periodically at rate specified by refresh_period

The default value is MANUAL.

Definition at line 236 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.REFRESH_PERIOD = "refresh_period"

When refresh_method is periodic, specifies the period in seconds at which refresh occurs

Definition at line 260 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.REFRESH_SPAN = "refresh_span"

Sets the future time-offset(in seconds) at which periodic refresh stops

Definition at line 193 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.REFRESH_START_TIME = "refresh_start_time"

When refresh_method is periodic, specifies the first time at which a refresh is to be done.

Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.

Definition at line 266 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.REFRESH_STOP_TIME = "refresh_stop_time"

When refresh_method is periodic, specifies the time at which a periodic refresh is stopped.

Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.

Definition at line 199 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.TRUE = "true"

Definition at line 188 of file CreateMaterializedView.cs.

const string kinetica.CreateMaterializedViewRequest.Options.TTL = "ttl"

Sets the TTL of the table specified in table_name.

Definition at line 271 of file CreateMaterializedView.cs.

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

Kinetica/Protocol/CreateMaterializedView.cs

Public Attributes

Detailed Description

Member Data Documentation