bigquery

package
v0.18.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package bigquery exports types, functions, subpackages for provisioning bigquery resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-gcp) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-gcp` repo](https://github.com/pulumi/pulumi-gcp/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-gcp` repo](https://github.com/terraform-providers/terraform-provider-gcp/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Dataset 

type Dataset struct {
	// contains filtered or unexported fields
}

Creates a dataset resource for Google BigQuery. For more information see [the official documentation](https://cloud.google.com/bigquery/docs/) and [API](https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets).

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/bigquery_dataset.html.markdown.

func GetDataset 

func GetDataset(ctx *pulumi.Context,
	name string, id pulumi.ID, state *DatasetState, opts ...pulumi.ResourceOpt) (*Dataset, error)

GetDataset gets an existing Dataset resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDataset 

func NewDataset(ctx *pulumi.Context,
	name string, args *DatasetArgs, opts ...pulumi.ResourceOpt) (*Dataset, error)

NewDataset registers a new resource with the given unique name, arguments, and options.

func (*Dataset) Accesses added in v0.16.0 

func (r *Dataset) Accesses() *pulumi.ArrayOutput

An array of objects that define dataset access for one or more entities. Structure is documented below.

func (*Dataset) CreationTime 

func (r *Dataset) CreationTime() *pulumi.IntOutput

The time when this dataset was created, in milliseconds since the epoch.

func (*Dataset) DatasetId 

func (r *Dataset) DatasetId() *pulumi.StringOutput

The ID of the dataset containing this table.

func (*Dataset) DefaultPartitionExpirationMs added in v0.18.0 

func (r *Dataset) DefaultPartitionExpirationMs() *pulumi.IntOutput

The default partition expiration for all partitioned tables in the dataset, in milliseconds.

func (*Dataset) DefaultTableExpirationMs 

func (r *Dataset) DefaultTableExpirationMs() *pulumi.IntOutput

The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour).

func (*Dataset) DeleteContentsOnDestroy added in v0.18.0 

func (r *Dataset) DeleteContentsOnDestroy() *pulumi.BoolOutput

If set to `true`, delete all the tables in the dataset when destroying the resource; otherwise, destroying the resource will fail if tables are present.

func (*Dataset) Description 

func (r *Dataset) Description() *pulumi.StringOutput

A user-friendly description of the dataset.

func (*Dataset) Etag 

func (r *Dataset) Etag() *pulumi.StringOutput

A hash of the resource.

func (*Dataset) FriendlyName 

func (r *Dataset) FriendlyName() *pulumi.StringOutput

A descriptive name for the dataset.

func (*Dataset) ID 

func (r *Dataset) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Dataset) Labels 

func (r *Dataset) Labels() *pulumi.MapOutput

A mapping of labels to assign to the resource.

func (*Dataset) LastModifiedTime 

func (r *Dataset) LastModifiedTime() *pulumi.IntOutput

The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

func (*Dataset) Location 

func (r *Dataset) Location() *pulumi.StringOutput

The geographic location where the dataset should reside. See [official docs](https://cloud.google.com/bigquery/docs/dataset-locations).

func (*Dataset) Project 

func (r *Dataset) Project() *pulumi.StringOutput

The ID of the project in which the resource belongs. If it is not provided, the provider project is used. 

func (r *Dataset) SelfLink() *pulumi.StringOutput

The URI of the created resource.

func (*Dataset) URN 

func (r *Dataset) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type DatasetArgs 

type DatasetArgs struct {
	// An array of objects that define dataset access for
	// one or more entities. Structure is documented below.
	Accesses interface{}
	// The ID of the dataset containing this table.
	DatasetId interface{}
	// The default partition expiration
	// for all partitioned tables in the dataset, in milliseconds.
	DefaultPartitionExpirationMs interface{}
	// The default lifetime of all
	// tables in the dataset, in milliseconds. The minimum value is 3600000
	// milliseconds (one hour).
	DefaultTableExpirationMs interface{}
	// If set to `true`, delete all the
	// tables in the dataset when destroying the resource; otherwise, destroying
	// the resource will fail if tables are present.
	DeleteContentsOnDestroy interface{}
	// A user-friendly description of the dataset.
	Description interface{}
	// A descriptive name for the dataset.
	FriendlyName interface{}
	// A mapping of labels to assign to the resource.
	Labels interface{}
	// The geographic location where the dataset should reside.
	// See [official docs](https://cloud.google.com/bigquery/docs/dataset-locations).
	Location interface{}
	// The ID of the project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
}

The set of arguments for constructing a Dataset resource.

type DatasetState 

type DatasetState struct {
	// An array of objects that define dataset access for
	// one or more entities. Structure is documented below.
	Accesses interface{}
	// The time when this dataset was created, in milliseconds since the epoch.
	CreationTime interface{}
	// The ID of the dataset containing this table.
	DatasetId interface{}
	// The default partition expiration
	// for all partitioned tables in the dataset, in milliseconds.
	DefaultPartitionExpirationMs interface{}
	// The default lifetime of all
	// tables in the dataset, in milliseconds. The minimum value is 3600000
	// milliseconds (one hour).
	DefaultTableExpirationMs interface{}
	// If set to `true`, delete all the
	// tables in the dataset when destroying the resource; otherwise, destroying
	// the resource will fail if tables are present.
	DeleteContentsOnDestroy interface{}
	// A user-friendly description of the dataset.
	Description interface{}
	// A hash of the resource.
	Etag interface{}
	// A descriptive name for the dataset.
	FriendlyName interface{}
	// A mapping of labels to assign to the resource.
	Labels interface{}
	// The date when this dataset or any of its tables was last modified,
	// in milliseconds since the epoch.
	LastModifiedTime interface{}
	// The geographic location where the dataset should reside.
	// See [official docs](https://cloud.google.com/bigquery/docs/dataset-locations).
	Location interface{}
	// The ID of the project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
	// The URI of the created resource.
	SelfLink interface{}
}

Input properties used for looking up and filtering Dataset resources.

type Table 

type Table struct {
	// contains filtered or unexported fields
}

Creates a table resource in a dataset for Google BigQuery. For more information see [the official documentation](https://cloud.google.com/bigquery/docs/) and [API](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables).

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/bigquery_table.html.markdown.

func GetTable 

func GetTable(ctx *pulumi.Context,
	name string, id pulumi.ID, state *TableState, opts ...pulumi.ResourceOpt) (*Table, error)

GetTable gets an existing Table resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTable 

func NewTable(ctx *pulumi.Context,
	name string, args *TableArgs, opts ...pulumi.ResourceOpt) (*Table, error)

NewTable registers a new resource with the given unique name, arguments, and options.

func (*Table) CreationTime 

func (r *Table) CreationTime() *pulumi.IntOutput

The time when this table was created, in milliseconds since the epoch.

func (*Table) DatasetId 

func (r *Table) DatasetId() *pulumi.StringOutput

The dataset ID to create the table in. Changing this forces a new resource to be created.

func (*Table) Description 

func (r *Table) Description() *pulumi.StringOutput

The field description.

func (*Table) Etag 

func (r *Table) Etag() *pulumi.StringOutput

A hash of the resource.

func (*Table) ExpirationTime 

func (r *Table) ExpirationTime() *pulumi.IntOutput

The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.

func (*Table) ExternalDataConfiguration added in v0.18.13 

func (r *Table) ExternalDataConfiguration() *pulumi.Output

Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. Structure is documented below.

func (*Table) FriendlyName 

func (r *Table) FriendlyName() *pulumi.StringOutput

A descriptive name for the table.

func (*Table) ID 

func (r *Table) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Table) Labels 

func (r *Table) Labels() *pulumi.MapOutput

A mapping of labels to assign to the resource.

func (*Table) LastModifiedTime 

func (r *Table) LastModifiedTime() *pulumi.IntOutput

The time when this table was last modified, in milliseconds since the epoch.

func (*Table) Location 

func (r *Table) Location() *pulumi.StringOutput

The geographic location where the table resides. This value is inherited from the dataset.

func (*Table) NumBytes 

func (r *Table) NumBytes() *pulumi.IntOutput

The size of this table in bytes, excluding any data in the streaming buffer.

func (*Table) NumLongTermBytes 

func (r *Table) NumLongTermBytes() *pulumi.IntOutput

The number of bytes in the table that are considered "long-term storage".

func (*Table) NumRows 

func (r *Table) NumRows() *pulumi.IntOutput

The number of rows of data in this table, excluding any data in the streaming buffer.

func (*Table) Project 

func (r *Table) Project() *pulumi.StringOutput

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

func (*Table) Schema 

func (r *Table) Schema() *pulumi.StringOutput

A JSON schema for the table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables. For more information see the [BigQuery API documentation](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource). 

func (r *Table) SelfLink() *pulumi.StringOutput

The URI of the created resource.

func (*Table) TableId 

func (r *Table) TableId() *pulumi.StringOutput

A unique ID for the resource. Changing this forces a new resource to be created.

func (*Table) TimePartitioning 

func (r *Table) TimePartitioning() *pulumi.Output

If specified, configures time-based partitioning for this table. Structure is documented below.

func (*Table) Type 

func (r *Table) Type() *pulumi.StringOutput

Describes the table type.

func (*Table) URN 

func (r *Table) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Table) View 

func (r *Table) View() *pulumi.Output

If specified, configures this table as a view. Structure is documented below.

type TableArgs 

type TableArgs struct {
	// The dataset ID to create the table in.
	// Changing this forces a new resource to be created.
	DatasetId interface{}
	// The field description.
	Description interface{}
	// The time when this table expires, in
	// milliseconds since the epoch. If not present, the table will persist
	// indefinitely. Expired tables will be deleted and their storage
	// reclaimed.
	ExpirationTime interface{}
	// Describes the data format,
	// location, and other properties of a table stored outside of BigQuery.
	// By defining these properties, the data source can then be queried as
	// if it were a standard BigQuery table. Structure is documented below.
	ExternalDataConfiguration interface{}
	// A descriptive name for the table.
	FriendlyName interface{}
	// A mapping of labels to assign to the resource.
	Labels interface{}
	// The ID of the project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
	// A JSON schema for the table. Schema is required
	// for CSV and JSON formats and is disallowed for Google Cloud
	// Bigtable, Cloud Datastore backups, and Avro formats when using
	// external tables. For more information see the
	// [BigQuery API documentation](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource).
	Schema interface{}
	// A unique ID for the resource.
	// Changing this forces a new resource to be created.
	TableId interface{}
	// If specified, configures time-based
	// partitioning for this table. Structure is documented below.
	TimePartitioning interface{}
	// If specified, configures this table as a view.
	// Structure is documented below.
	View interface{}
}

The set of arguments for constructing a Table resource.

type TableState 

type TableState struct {
	// The time when this table was created, in milliseconds since the epoch.
	CreationTime interface{}
	// The dataset ID to create the table in.
	// Changing this forces a new resource to be created.
	DatasetId interface{}
	// The field description.
	Description interface{}
	// A hash of the resource.
	Etag interface{}
	// The time when this table expires, in
	// milliseconds since the epoch. If not present, the table will persist
	// indefinitely. Expired tables will be deleted and their storage
	// reclaimed.
	ExpirationTime interface{}
	// Describes the data format,
	// location, and other properties of a table stored outside of BigQuery.
	// By defining these properties, the data source can then be queried as
	// if it were a standard BigQuery table. Structure is documented below.
	ExternalDataConfiguration interface{}
	// A descriptive name for the table.
	FriendlyName interface{}
	// A mapping of labels to assign to the resource.
	Labels interface{}
	// The time when this table was last modified, in milliseconds since the epoch.
	LastModifiedTime interface{}
	// The geographic location where the table resides. This value is inherited from the dataset.
	Location interface{}
	// The size of this table in bytes, excluding any data in the streaming buffer.
	NumBytes interface{}
	// The number of bytes in the table that are considered "long-term storage".
	NumLongTermBytes interface{}
	// The number of rows of data in this table, excluding any data in the streaming buffer.
	NumRows interface{}
	// The ID of the project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
	// A JSON schema for the table. Schema is required
	// for CSV and JSON formats and is disallowed for Google Cloud
	// Bigtable, Cloud Datastore backups, and Avro formats when using
	// external tables. For more information see the
	// [BigQuery API documentation](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource).
	Schema interface{}
	// The URI of the created resource.
	SelfLink interface{}
	// A unique ID for the resource.
	// Changing this forces a new resource to be created.
	TableId interface{}
	// If specified, configures time-based
	// partitioning for this table. Structure is documented below.
	TimePartitioning interface{}
	// Describes the table type.
	Type interface{}
	// If specified, configures this table as a view.
	// Structure is documented below.
	View interface{}
}

Input properties used for looking up and filtering Table resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.