Kinetica C# API  Version 6.2.0.1
kinetica.CreateMaterializedViewRequest Class Reference

A set of parameters for Kinetica.createMaterializedView(string,IDictionary<string, string>). More...

+ Inheritance diagram for kinetica.CreateMaterializedViewRequest:
+ Collaboration diagram for kinetica.CreateMaterializedViewRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

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

Properties

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

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. More...
 

Detailed Description

A set of parameters for Kinetica.createMaterializedView(string,IDictionary<string, string>).


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 <member name="view_id">, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Definition at line 29 of file CreateMaterializedView.cs.

Constructor & Destructor Documentation

◆ CreateMaterializedViewRequest() [1/2]

kinetica.CreateMaterializedViewRequest.CreateMaterializedViewRequest ( )
inline

Constructs a CreateMaterializedViewRequest object with default parameters.

Definition at line 333 of file CreateMaterializedView.cs.

◆ CreateMaterializedViewRequest() [2/2]

kinetica.CreateMaterializedViewRequest.CreateMaterializedViewRequest ( string  table_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.
optionsOptional 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 table will be a top-level table.
  • TTL: Sets the TTL of the table specified in .
  • 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: The default value is FALSE.
  • 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: For future use.
    • 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'.
The default value is an empty Dictionary.

Definition at line 434 of file CreateMaterializedView.cs.

Property Documentation

◆ options

IDictionary<string, string> kinetica.CreateMaterializedViewRequest.options
getset

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 table will be a top-level table.
  • TTL: Sets the TTL of the table specified in .
  • 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: The default value is FALSE.
  • 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: For future use.
    • 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'.

The default value is an empty Dictionary.

Definition at line 328 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.

Definition at line 233 of file CreateMaterializedView.cs.


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