Module bigquery

@pulumi/gcp > bigquery

Index

bigquery/dataset.ts bigquery/table.ts

class Dataset

Creates a dataset resource for Google BigQuery. For more information see the official documentation and API.

constructor

new Dataset(name: string, args: DatasetArgs, opts?: pulumi.CustomResourceOptions)

Create a Dataset resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DatasetState): Dataset

Get an existing Dataset resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accesses

public accesses: pulumi.Output<{ ... }[]>;

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

property creationTime

public creationTime: pulumi.Output<number>;

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

property datasetId

public datasetId: pulumi.Output<string>;

The ID of the dataset containing this table.

property defaultTableExpirationMs

public defaultTableExpirationMs: pulumi.Output<number | undefined>;

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

property description

public description: pulumi.Output<string | undefined>;

A user-friendly description of the dataset.

property etag

public etag: pulumi.Output<string>;

A hash of the resource.

property friendlyName

public friendlyName: pulumi.Output<string | undefined>;

A descriptive name for the dataset.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{ ... } | undefined>;

A mapping of labels to assign to the resource.

property lastModifiedTime

public lastModifiedTime: pulumi.Output<number>;

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

property location

public location: pulumi.Output<string | undefined>;

The geographic location where the dataset should reside. See official docs.

property project

public project: pulumi.Output<string>;

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

property selfLink

public selfLink: pulumi.Output<string>;

The URI of the created resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Table

Creates a table resource in a dataset for Google BigQuery. For more information see the official documentation and API.

constructor

new Table(name: string, args: TableArgs, opts?: pulumi.CustomResourceOptions)

Create a Table resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TableState): Table

Get an existing Table resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property creationTime

public creationTime: pulumi.Output<number>;

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

property datasetId

public datasetId: pulumi.Output<string>;

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

property description

public description: pulumi.Output<string | undefined>;

The field description.

property etag

public etag: pulumi.Output<string>;

A hash of the resource.

property expirationTime

public expirationTime: pulumi.Output<number>;

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.

property friendlyName

public friendlyName: pulumi.Output<string | undefined>;

A descriptive name for the table.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{ ... } | undefined>;

A mapping of labels to assign to the resource.

property lastModifiedTime

public lastModifiedTime: pulumi.Output<number>;

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

property location

public location: pulumi.Output<string>;

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

property numBytes

public numBytes: pulumi.Output<number>;

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

property numLongTermBytes

public numLongTermBytes: pulumi.Output<number>;

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

property numRows

public numRows: pulumi.Output<number>;

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

property project

public project: pulumi.Output<string>;

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

property schema

public schema: pulumi.Output<string>;

A JSON schema for the table.

property selfLink

public selfLink: pulumi.Output<string>;

The URI of the created resource.

property tableId

public tableId: pulumi.Output<string>;

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

property timePartitioning

public timePartitioning: pulumi.Output<{ ... } | undefined>;

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

property type

public type: pulumi.Output<string>;

Describes the table type.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property view

public view: pulumi.Output<{ ... } | undefined>;

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

interface DatasetArgs

The set of arguments for constructing a Dataset resource.

property accesses

accesses?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property datasetId

datasetId: pulumi.Input<string>;

The ID of the dataset containing this table.

property defaultTableExpirationMs

defaultTableExpirationMs?: pulumi.Input<number>;

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

property description

description?: pulumi.Input<string>;

A user-friendly description of the dataset.

property friendlyName

friendlyName?: pulumi.Input<string>;

A descriptive name for the dataset.

property labels

labels?: pulumi.Input<{ ... }>;

A mapping of labels to assign to the resource.

property location

location?: pulumi.Input<string>;

The geographic location where the dataset should reside. See official docs.

property project

project?: pulumi.Input<string>;

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

interface DatasetState

Input properties used for looking up and filtering Dataset resources.

property accesses

accesses?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property creationTime

creationTime?: pulumi.Input<number>;

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

property datasetId

datasetId?: pulumi.Input<string>;

The ID of the dataset containing this table.

property defaultTableExpirationMs

defaultTableExpirationMs?: pulumi.Input<number>;

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

property description

description?: pulumi.Input<string>;

A user-friendly description of the dataset.

property etag

etag?: pulumi.Input<string>;

A hash of the resource.

property friendlyName

friendlyName?: pulumi.Input<string>;

A descriptive name for the dataset.

property labels

labels?: pulumi.Input<{ ... }>;

A mapping of labels to assign to the resource.

property lastModifiedTime

lastModifiedTime?: pulumi.Input<number>;

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

property location

location?: pulumi.Input<string>;

The geographic location where the dataset should reside. See official docs.

property project

project?: pulumi.Input<string>;

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

property selfLink

selfLink?: pulumi.Input<string>;

The URI of the created resource.

interface TableArgs

The set of arguments for constructing a Table resource.

property datasetId

datasetId: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The field description.

property expirationTime

expirationTime?: pulumi.Input<number>;

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.

property friendlyName

friendlyName?: pulumi.Input<string>;

A descriptive name for the table.

property labels

labels?: pulumi.Input<{ ... }>;

A mapping of labels to assign to the resource.

property project

project?: pulumi.Input<string>;

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

property schema

schema?: pulumi.Input<string>;

A JSON schema for the table.

property tableId

tableId: pulumi.Input<string>;

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

property timePartitioning

timePartitioning?: pulumi.Input<{ ... }>;

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

property view

view?: pulumi.Input<{ ... }>;

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

interface TableState

Input properties used for looking up and filtering Table resources.

property creationTime

creationTime?: pulumi.Input<number>;

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

property datasetId

datasetId?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The field description.

property etag

etag?: pulumi.Input<string>;

A hash of the resource.

property expirationTime

expirationTime?: pulumi.Input<number>;

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.

property friendlyName

friendlyName?: pulumi.Input<string>;

A descriptive name for the table.

property labels

labels?: pulumi.Input<{ ... }>;

A mapping of labels to assign to the resource.

property lastModifiedTime

lastModifiedTime?: pulumi.Input<number>;

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

property location

location?: pulumi.Input<string>;

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

property numBytes

numBytes?: pulumi.Input<number>;

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

property numLongTermBytes

numLongTermBytes?: pulumi.Input<number>;

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

property numRows

numRows?: pulumi.Input<number>;

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

property project

project?: pulumi.Input<string>;

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

property schema

schema?: pulumi.Input<string>;

A JSON schema for the table.

property selfLink

selfLink?: pulumi.Input<string>;

The URI of the created resource.

property tableId

tableId?: pulumi.Input<string>;

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

property timePartitioning

timePartitioning?: pulumi.Input<{ ... }>;

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

property type

type?: pulumi.Input<string>;

Describes the table type.

property view

view?: pulumi.Input<{ ... }>;

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