A set of string constants for the parameter CreateMaterializedViewRequest.options. More…
Static Public Attributes | |
| const string | COLLECTION_NAME = “collection_name” |
| [DEPRECATED–please specify the containing schema for the materialized view as part of CreateMaterializedViewRequest.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. | |
| const string | EXECUTE_AS = “execute_as” |
| User name to use to run the refresh job. | |
| const string | BUILD_MATERIALIZED_VIEW_POLICY = “build_materialized_view_policy” |
| Sets startup materialized view rebuild scheme. | |
| const string | ALWAYS = “always” |
| Rebuild as many materialized views as possible before accepting requests. | |
| const string | LAZY = “lazy” |
| Rebuild the necessary materialized views at start, and load the remainder lazily. | |
| const string | ON_DEMAND = “on_demand” |
| Rebuild materialized views as requests use them. | |
| const string | SYSTEM = “system” |
| Rebuild materialized views using the system-configured default. | |
| const string | PERSIST = “persist” |
| If TRUE, then the materialized view specified in CreateMaterializedViewRequest.table_name will be persisted and will not expire unless a TTL is specified. | |
| const string | TRUE = “true” |
| A boolean constant for the CreateMaterializedViewRequest.Options options. | |
| const string | FALSE = “false” |
| A boolean constant for the CreateMaterializedViewRequest.Options options. | |
| const string | ENABLE_MV_INPUT_WRAPPERS = “enable_mv_input_wrappers” |
| If TRUE, each base table the view reads is accessed through a wrapper view so an in-progress out-of-place update cannot make a record momentarily disappear from the view, and a long refresh does not block updates to the base tables. | |
| const string | REFRESH_SPAN = “refresh_span” |
| Sets the future time-offset(in seconds) at which periodic refresh stops. | |
| const string | REFRESH_STOP_TIME = “refresh_stop_time” |
| When REFRESH_METHOD is PERIODIC, specifies the time at which a periodic refresh is stopped. | |
| const string | REFRESH_METHOD = “refresh_method” |
| Method by which the join can be refreshed when the data in underlying member tables have changed. | |
| const string | MANUAL = “manual” |
| Refresh only occurs when manually requested by calling Kinetica.alterTable with an ‘action’ of ‘refresh’. | |
| const string | ON_QUERY = “on_query” |
| Refresh any time the view is queried. | |
| 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. | |
| const string | PERIODIC = “periodic” |
| Refresh table periodically at rate specified by REFRESH_PERIOD. | |
| const string | REFRESH_PERIOD = “refresh_period” |
| When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which refresh occurs. | |
| 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. | |
| const string | TTL = “ttl” |
| Sets the TTL of the table specified in CreateMaterializedViewRequest.table_name. | |
Detailed Description
A set of string constants for the parameter CreateMaterializedViewRequest.options.
Optional parameters.
Definition at line 29 of file CreateMaterializedView.cs.
Member Data Documentation
◆ ALWAYS
| static |
Rebuild as many materialized views as possible before accepting requests.
Definition at line 83 of file CreateMaterializedView.cs.
◆ BUILD_MATERIALIZED_VIEW_POLICY
| static |
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 79 of file CreateMaterializedView.cs.
◆ COLLECTION_NAME
| static |
[DEPRECATED–please specify the containing schema for the materialized view as part of CreateMaterializedViewRequest.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.
◆ ENABLE_MV_INPUT_WRAPPERS
| static |
If TRUE, each base table the view reads is accessed through a wrapper view so an in-progress out-of-place update cannot make a record momentarily disappear from the view, and a long refresh does not block updates to the base tables.
Overrides the gaia.enable_mv_input_wrappers configuration default when set. Supported values:
The default value is FALSE.
Definition at line 159 of file CreateMaterializedView.cs.
◆ EXECUTE_AS
| static |
User name to use to run the refresh job.
Definition at line 42 of file CreateMaterializedView.cs.
◆ FALSE
| static |
A boolean constant for the CreateMaterializedViewRequest.Options options.
Definition at line 133 of file CreateMaterializedView.cs.
◆ LAZY
| static |
Rebuild the necessary materialized views at start, and load the remainder lazily.
Definition at line 87 of file CreateMaterializedView.cs.
◆ MANUAL
| static |
Refresh only occurs when manually requested by calling Kinetica.alterTable with an ‘action’ of ‘refresh’.
Definition at line 224 of file CreateMaterializedView.cs.
◆ ON_CHANGE
| static |
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 234 of file CreateMaterializedView.cs.
◆ ON_DEMAND
| static |
Rebuild materialized views as requests use them.
Definition at line 90 of file CreateMaterializedView.cs.
◆ ON_QUERY
| static |
Refresh any time the view is queried.
Definition at line 227 of file CreateMaterializedView.cs.
◆ PERIODIC
| static |
Refresh table periodically at rate specified by REFRESH_PERIOD.
Definition at line 239 of file CreateMaterializedView.cs.
◆ PERSIST
| static |
If TRUE, then the materialized view specified in CreateMaterializedViewRequest.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:
The default value is FALSE.
Definition at line 125 of file CreateMaterializedView.cs.
◆ REFRESH_METHOD
| static |
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 218 of file CreateMaterializedView.cs.
◆ REFRESH_PERIOD
| static |
When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which refresh occurs.
Definition at line 246 of file CreateMaterializedView.cs.
◆ REFRESH_SPAN
| static |
Sets the future time-offset(in seconds) at which periodic refresh stops.
Definition at line 163 of file CreateMaterializedView.cs.
◆ REFRESH_START_TIME
| static |
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 256 of file CreateMaterializedView.cs.
◆ REFRESH_STOP_TIME
| static |
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 173 of file CreateMaterializedView.cs.
◆ SYSTEM
| static |
Rebuild materialized views using the system-configured default.
Definition at line 94 of file CreateMaterializedView.cs.
◆ TRUE
| static |
A boolean constant for the CreateMaterializedViewRequest.Options options.
Definition at line 129 of file CreateMaterializedView.cs.
◆ TTL
| static |
Sets the TTL of the table specified in CreateMaterializedViewRequest.table_name.
Definition at line 261 of file CreateMaterializedView.cs.
The documentation for this struct was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateMaterializedView.cs
- Kinetica/Protocol/CreateMaterializedView.cs