A set of parameters for GPUdb::createMaterializedView. More...

#include <gpudb/protocol/create_materialized_view.h>

Public Member Functions
	CreateMaterializedViewRequest ()
	Constructs a CreateMaterializedViewRequest object with default parameters. More...

	CreateMaterializedViewRequest (const std::string &tableName_, const std::map< std::string, std::string > &options_)
	Constructs a CreateMaterializedViewRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
	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. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::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 viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Definition at line 28 of file create_materialized_view.h.

Constructor & Destructor Documentation

◆ CreateMaterializedViewRequest() [1/2]

gpudb::CreateMaterializedViewRequest::CreateMaterializedViewRequest ( )

inline

Constructs a CreateMaterializedViewRequest object with default parameters.

Definition at line 34 of file create_materialized_view.h.

◆ CreateMaterializedViewRequest() [2/2]

gpudb::CreateMaterializedViewRequest::CreateMaterializedViewRequest	(	const std::string &	tableName_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a CreateMaterializedViewRequest object with the specified parameters.

Parameters

[in]	tableName_	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.
[in]	options_	Optional parameters. create_materialized_view_collection_name: [DEPRECATED–please specify the containing schema for the materialized view as part of tableName_ and use GPUdb::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. create_materialized_view_execute_as: User name to use to run the refresh job create_materialized_view_build_materialized_view_policy: Sets startup materialized view rebuild scheme. Supported values: create_materialized_view_always: Rebuild as many materialized views as possible before accepting requests. create_materialized_view_lazy: Rebuild the necessary materialized views at start, and load the remainder lazily. create_materialized_view_on_demand: Rebuild materialized views as requests use them. create_materialized_view_system: Rebuild materialized views using the system-configured default. The default value is create_materialized_view_system. create_materialized_view_persist: If true, then the materialized view specified in tableName_ 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: create_materialized_view_true create_materialized_view_false The default value is create_materialized_view_false. create_materialized_view_refresh_span: Sets the future time-offset(in seconds) at which periodic refresh stops create_materialized_view_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'. create_materialized_view_refresh_method: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values: create_materialized_view_manual: Refresh only occurs when manually requested by calling GPUdb::alterTable with an 'action' of 'refresh' create_materialized_view_on_query: Refresh any time the view is queried. create_materialized_view_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. create_materialized_view_periodic: Refresh table periodically at rate specified by refresh_period The default value is create_materialized_view_manual. create_materialized_view_refresh_period: When refresh_method is periodic, specifies the period in seconds at which refresh occurs create_materialized_view_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'. create_materialized_view_ttl: Sets the TTL of the table specified in tableName_. The default value is an empty map.

Definition at line 225 of file create_materialized_view.h.

Member Data Documentation

◆ options

std::map<std::string, std::string> gpudb::CreateMaterializedViewRequest::options

Optional parameters.

create_materialized_view_collection_name: [DEPRECATED–please specify the containing schema for the materialized view as part of tableName and use GPUdb::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.
create_materialized_view_execute_as: User name to use to run the refresh job
create_materialized_view_build_materialized_view_policy: Sets startup materialized view rebuild scheme. Supported values:
- create_materialized_view_always: Rebuild as many materialized views as possible before accepting requests.
- create_materialized_view_lazy: Rebuild the necessary materialized views at start, and load the remainder lazily.
- create_materialized_view_on_demand: Rebuild materialized views as requests use them.
- create_materialized_view_system: Rebuild materialized views using the system-configured default.
The default value is create_materialized_view_system.
create_materialized_view_persist: If true, then the materialized view specified in tableName 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:
- create_materialized_view_true
- create_materialized_view_false
The default value is create_materialized_view_false.
create_materialized_view_refresh_span: Sets the future time-offset(in seconds) at which periodic refresh stops
create_materialized_view_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'.
create_materialized_view_refresh_method: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
- create_materialized_view_manual: Refresh only occurs when manually requested by calling GPUdb::alterTable with an 'action' of 'refresh'
- create_materialized_view_on_query: Refresh any time the view is queried.
- create_materialized_view_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.
- create_materialized_view_periodic: Refresh table periodically at rate specified by refresh_period
The default value is create_materialized_view_manual.
create_materialized_view_refresh_period: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
create_materialized_view_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'.
create_materialized_view_ttl: Sets the TTL of the table specified in tableName.

The default value is an empty map.

Definition at line 362 of file create_materialized_view.h.

◆ tableName

std::string gpudb::CreateMaterializedViewRequest::tableName

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 239 of file create_materialized_view.h.

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

gpudb/protocol/create_materialized_view.h

Public Member Functions