Kinetica   C#   API  Version 7.2.3.0
kinetica.CreateMaterializedViewRequest.Options Struct Reference

A set of string constants for the parameter options. 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 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 BUILD_MATERIALIZED_VIEW_POLICY = "build_materialized_view_policy"
 Sets startup materialized view rebuild scheme. More...
 
const string ALWAYS = "always"
 Rebuild as many materialized views as possible before accepting requests. More...
 
const string LAZY = "lazy"
 Rebuild the necessary materialized views at start, and load the remainder lazily. More...
 
const string ON_DEMAND = "on_demand"
 Rebuild materialized views as requests use them. More...
 
const string SYSTEM = "system"
 Rebuild materialized views using the system-configured default. 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 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

A set of string constants for the parameter options.

Optional parameters.

Definition at line 29 of file CreateMaterializedView.cs.

Member Data Documentation

◆ ALWAYS

const string kinetica.CreateMaterializedViewRequest.Options.ALWAYS = "always"

Rebuild as many materialized views as possible before accepting requests.

Definition at line 76 of file CreateMaterializedView.cs.

◆ BUILD_MATERIALIZED_VIEW_POLICY

const string kinetica.CreateMaterializedViewRequest.Options.BUILD_MATERIALIZED_VIEW_POLICY = "build_materialized_view_policy"

Sets startup materialized view rebuild scheme.

Supported values:

  • ALWAYS: Rebuild as many materialized views as possible before accepting requests.
  • LAZY: Rebuild the necessary materialized views at start, and load the remainder lazily.
  • ON_DEMAND: Rebuild materialized views as requests use them.
  • SYSTEM: Rebuild materialized views using the system-configured default.

The default value is SYSTEM.

Definition at line 72 of file CreateMaterializedView.cs.

◆ COLLECTION_NAME

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 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 39 of file CreateMaterializedView.cs.

◆ EXECUTE_AS

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

User name to use to run the refresh job

Definition at line 42 of file CreateMaterializedView.cs.

◆ FALSE

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

Definition at line 108 of file CreateMaterializedView.cs.

◆ LAZY

const string kinetica.CreateMaterializedViewRequest.Options.LAZY = "lazy"

Rebuild the necessary materialized views at start, and load the remainder lazily.

Definition at line 80 of file CreateMaterializedView.cs.

◆ MANUAL

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

Refresh only occurs when manually requested by calling Kinetica.alterTable with an 'action' of 'refresh'

Definition at line 165 of file CreateMaterializedView.cs.

◆ ON_CHANGE

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 175 of file CreateMaterializedView.cs.

◆ ON_DEMAND

const string kinetica.CreateMaterializedViewRequest.Options.ON_DEMAND = "on_demand"

Rebuild materialized views as requests use them.

Definition at line 84 of file CreateMaterializedView.cs.

◆ ON_QUERY

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

Refresh any time the view is queried.

Definition at line 168 of file CreateMaterializedView.cs.

◆ PERIODIC

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

Refresh table periodically at rate specified by REFRESH_PERIOD

Definition at line 179 of file CreateMaterializedView.cs.

◆ PERSIST

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.

Supported values:

The default value is FALSE.

Definition at line 105 of file CreateMaterializedView.cs.

◆ REFRESH_METHOD

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 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 159 of file CreateMaterializedView.cs.

◆ REFRESH_PERIOD

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 185 of file CreateMaterializedView.cs.

◆ REFRESH_SPAN

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

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

Definition at line 112 of file CreateMaterializedView.cs.

◆ REFRESH_START_TIME

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 193 of file CreateMaterializedView.cs.

◆ REFRESH_STOP_TIME

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 120 of file CreateMaterializedView.cs.

◆ SYSTEM

const string kinetica.CreateMaterializedViewRequest.Options.SYSTEM = "system"

Rebuild materialized views using the system-configured default.

Definition at line 88 of file CreateMaterializedView.cs.

◆ TRUE

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

Definition at line 107 of file CreateMaterializedView.cs.

◆ TTL

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

Sets the TTL of the table specified in table_name.

Definition at line 198 of file CreateMaterializedView.cs.


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