Skip to main content

A set of parameters for Kinetica.createMaterializedView. More…

Inheritance diagram for kinetica.CreateMaterializedViewRequest:
[legend]
Collaboration diagram for kinetica.CreateMaterializedViewRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter CreateMaterializedViewRequest.options. More…
 

​
Public Member Functions

 CreateMaterializedViewRequest ()
 Constructs a CreateMaterializedViewRequest object with default parameters.
 
 CreateMaterializedViewRequest (string table_name, IDictionary< string, string > options=null)
 Constructs a CreateMaterializedViewRequest object with the specified parameters.
 
 CreateMaterializedViewRequest ()
 Constructs a CreateMaterializedViewRequest object with default parameters.
 
 CreateMaterializedViewRequest (string table_name, IDictionary< string, string > options=null)
 Constructs a CreateMaterializedViewRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

string table_name [get, set]
 Name of the table to be created that is the top-level table of the materialized view, in [schema_name.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.createMaterializedView.

Initiates the process of creating a materialized view, reserving the view’s name to prevent other views or tables from being created with that name.

For materialized view details and examples, see Materialized Views.

The response contains view_id, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Definition at line 24 of file CreateMaterializedView.cs.

​
Constructor & Destructor Documentation

​
◆ CreateMaterializedViewRequest() [1/4]

kinetica.CreateMaterializedViewRequest.CreateMaterializedViewRequest ()
 inline

Constructs a CreateMaterializedViewRequest object with default parameters.

Definition at line 499 of file CreateMaterializedView.cs.

​
◆ CreateMaterializedViewRequest() [2/4]

kinetica.CreateMaterializedViewRequest.CreateMaterializedViewRequest (stringtable_name,
IDictionary< string, string >options = null )
 inline

Constructs a CreateMaterializedViewRequest object with the specified parameters.

Parameters
table_nameName of the table to be created that is the top-level table of the materialized view, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
optionsOptional parameters.
  • 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.
  • EXECUTE_AS: User name to use to run the refresh job.
  • 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.
  • 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:The default value is FALSE.
  • 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. Overrides the gaia.enable_mv_input_wrappers configuration default when set. Supported values: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 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.
  • 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 table_name .
The default value is an empty Dictionary.

Definition at line 733 of file CreateMaterializedView.cs.

​
◆ CreateMaterializedViewRequest() [3/4]

kinetica.CreateMaterializedViewRequest.CreateMaterializedViewRequest ()
 inline

Constructs a CreateMaterializedViewRequest object with default parameters.

Definition at line 499 of file CreateMaterializedView.cs.

​
◆ CreateMaterializedViewRequest() [4/4]

kinetica.CreateMaterializedViewRequest.CreateMaterializedViewRequest (stringtable_name,
IDictionary< string, string >options = null )
 inline

Constructs a CreateMaterializedViewRequest object with the specified parameters.

Parameters
table_nameName of the table to be created that is the top-level table of the materialized view, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
optionsOptional parameters.
  • 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.
  • EXECUTE_AS: User name to use to run the refresh job.
  • 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.
  • 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:The default value is FALSE.
  • 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. Overrides the gaia.enable_mv_input_wrappers configuration default when set. Supported values: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 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.
  • 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 table_name .
The default value is an empty Dictionary.

Definition at line 733 of file CreateMaterializedView.cs.

​
Property Documentation

​
◆ options

IDictionary< string, string > kinetica.CreateMaterializedViewRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

  • 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. If the schema provided is non-existent, it will be automatically created.
  • EXECUTE_AS: User name to use to run the refresh job.
  • 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.
  • PERSIST: 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.
  • 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. Overrides the gaia.enable_mv_input_wrappers configuration default when set. Supported values: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 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.
  • 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 CreateMaterializedViewRequest.table_name.

The default value is an empty Dictionary.

Definition at line 495 of file CreateMaterializedView.cs.

​
◆ table_name

string kinetica.CreateMaterializedViewRequest.table_name
 getset

Name of the table to be created that is the top-level table of the materialized view, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria.

Definition at line 270 of file CreateMaterializedView.cs.

The documentation for this class was generated from the following files: