LogicalView class

A logical view object that can be referenced in SQL queries.

To get more information about LogicalView, see:

• API documentation

Example Usage

Bigtable Logical View

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const instance = new gcp.bigtable.Instance("instance", {
    name: "bt-instance",
    clusters: [{
        clusterId: "cluster-1",
        zone: "us-east1-b",
        numNodes: 3,
        storageType: "HDD",
    }],
    deletionProtection: false,
});
const table = new gcp.bigtable.Table("table", {
    name: "bt-table",
    instanceName: instance.name,
    columnFamilies: [{
        family: "CF",
    }],
});
const logicalView = new gcp.bigtable.LogicalView("logical_view", {
    logicalViewId: "bt-logical-view",
    instance: instance.name,
    deletionProtection: false,
    query: `SELECT _key, CF
FROM \` + \\"\`bt-table\`\\" + \`
`,
}, {
    dependsOn: [table],
});

import pulumi
import pulumi_gcp as gcp

instance = gcp.bigtable.Instance("instance",
    name="bt-instance",
    clusters=[{
        "cluster_id": "cluster-1",
        "zone": "us-east1-b",
        "num_nodes": 3,
        "storage_type": "HDD",
    }],
    deletion_protection=False)
table = gcp.bigtable.Table("table",
    name="bt-table",
    instance_name=instance.name,
    column_families=[{
        "family": "CF",
    }])
logical_view = gcp.bigtable.LogicalView("logical_view",
    logical_view_id="bt-logical-view",
    instance=instance.name,
    deletion_protection=False,
    query="""SELECT _key, CF
FROM ` + \"`bt-table`\" + `
""",
    opts = pulumi.ResourceOptions(depends_on=[table]))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var instance = new Gcp.BigTable.Instance("instance", new()
    {
        Name = "bt-instance",
        Clusters = new[]
        {
            new Gcp.BigTable.Inputs.InstanceClusterArgs
            {
                ClusterId = "cluster-1",
                Zone = "us-east1-b",
                NumNodes = 3,
                StorageType = "HDD",
            },
        },
        DeletionProtection = false,
    });

    var table = new Gcp.BigTable.Table("table", new()
    {
        Name = "bt-table",
        InstanceName = instance.Name,
        ColumnFamilies = new[]
        {
            new Gcp.BigTable.Inputs.TableColumnFamilyArgs
            {
                Family = "CF",
            },
        },
    });

    var logicalView = new Gcp.BigTable.LogicalView("logical_view", new()
    {
        LogicalViewId = "bt-logical-view",
        Instance = instance.Name,
        DeletionProtection = false,
        Query = @"SELECT _key, CF
FROM ` + \""`bt-table`\"" + `
",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            table,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/bigtable"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := bigtable.NewInstance(ctx, "instance", &bigtable.InstanceArgs{
			Name: pulumi.String("bt-instance"),
			Clusters: bigtable.InstanceClusterArray{
				&bigtable.InstanceClusterArgs{
					ClusterId:   pulumi.String("cluster-1"),
					Zone:        pulumi.String("us-east1-b"),
					NumNodes:    pulumi.Int(3),
					StorageType: pulumi.String("HDD"),
				},
			},
			DeletionProtection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		table, err := bigtable.NewTable(ctx, "table", &bigtable.TableArgs{
			Name:         pulumi.String("bt-table"),
			InstanceName: instance.Name,
			ColumnFamilies: bigtable.TableColumnFamilyArray{
				&bigtable.TableColumnFamilyArgs{
					Family: pulumi.String("CF"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = bigtable.NewLogicalView(ctx, "logical_view", &bigtable.LogicalViewArgs{
			LogicalViewId:      pulumi.String("bt-logical-view"),
			Instance:           instance.Name,
			DeletionProtection: pulumi.Bool(false),
			Query:              pulumi.String("SELECT _key, CF\nFROM ` + \\\"`bt-table`\\\" + `\n"),
		}, pulumi.DependsOn([]pulumi.Resource{
			table,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_bigtable_instance" "instance" {
  name = "bt-instance"
  clusters {
    cluster_id   = "cluster-1"
    zone         = "us-east1-b"
    num_nodes    = 3
    storage_type = "HDD"
  }
  deletion_protection = false
}
resource "gcp_bigtable_table" "table" {
  name          = "bt-table"
  instance_name = gcp_bigtable_instance.instance.name
  column_families {
    family = "CF"
  }
}
resource "gcp_bigtable_logicalview" "logical_view" {
  depends_on          = [gcp_bigtable_table.table]
  logical_view_id     = "bt-logical-view"
  instance            = gcp_bigtable_instance.instance.name
  deletion_protection = false
  query               = "SELECT _key, CF\nFROM ` + \\\"`bt-table`\\\" + `\n"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigtable.Instance;
import com.pulumi.gcp.bigtable.InstanceArgs;
import com.pulumi.gcp.bigtable.inputs.InstanceClusterArgs;
import com.pulumi.gcp.bigtable.Table;
import com.pulumi.gcp.bigtable.TableArgs;
import com.pulumi.gcp.bigtable.inputs.TableColumnFamilyArgs;
import com.pulumi.gcp.bigtable.LogicalView;
import com.pulumi.gcp.bigtable.LogicalViewArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var instance = new Instance("instance", InstanceArgs.builder()
            .name("bt-instance")
            .clusters(InstanceClusterArgs.builder()
                .clusterId("cluster-1")
                .zone("us-east1-b")
                .numNodes(3)
                .storageType("HDD")
                .build())
            .deletionProtection(false)
            .build());

        var table = new Table("table", TableArgs.builder()
            .name("bt-table")
            .instanceName(instance.name())
            .columnFamilies(TableColumnFamilyArgs.builder()
                .family("CF")
                .build())
            .build());

        var logicalView = new LogicalView("logicalView", LogicalViewArgs.builder()
            .logicalViewId("bt-logical-view")
            .instance(instance.name())
            .deletionProtection(false)
            .query("""
SELECT _key, CF
FROM ` + \"`bt-table`\" + `
            """)
            .build(), CustomResourceOptions.builder()
                .dependsOn(table)
                .build());

    }
}

resources:
  instance:
    type: gcp:bigtable:Instance
    properties:
      name: bt-instance
      clusters:
        - clusterId: cluster-1
          zone: us-east1-b
          numNodes: 3
          storageType: HDD
      deletionProtection: false
  table:
    type: gcp:bigtable:Table
    properties:
      name: bt-table
      instanceName: ${instance.name}
      columnFamilies:
        - family: CF
  logicalView:
    type: gcp:bigtable:LogicalView
    name: logical_view
    properties:
      logicalViewId: bt-logical-view
      instance: ${instance.name}
      deletionProtection: false
      query: |
        SELECT _key, CF
        FROM ` + \"`bt-table`\" + `
    options:
      dependsOn:
        - ${table}

Import

LogicalView can be imported using any of these accepted formats:

• projects/{{project}}/instances/{{instance}}/logicalViews/{{logical_view_id}}
• {{project}}/{{instance}}/{{logical_view_id}}
• {{instance}}/{{logical_view_id}}

When using the pulumi import command, LogicalView can be imported using one of the formats above. For example:

$ pulumi import gcp:bigtable/logicalView:LogicalView default projects/{{project}}/instances/{{instance}}/logicalViews/{{logical_view_id}}
$ pulumi import gcp:bigtable/logicalView:LogicalView default {{project}}/{{instance}}/{{logical_view_id}}
$ pulumi import gcp:bigtable/logicalView:LogicalView default {{instance}}/{{logical_view_id}}

Constructors

LogicalView(String name, {LogicalViewArgs? args, CustomResourceOptions? options})

Creates a new LogicalView. name The Pulumi resource name. args Arguments used to configure this LogicalView. The set of arguments for LogicalView. options Resource options controlling this resource's behavior.

LogicalView.reference(String urn)

Creates a typed reference to an existing LogicalView resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

deletionProtection ↔ Output<bool?>

Set to true to make the logical view protected against deletion.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

instance ↔ Output<String?>

The name of the instance to create the logical view within.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

logicalViewId ↔ Output<String>

The unique name of the logical view in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.

late, final

name ↔ Output<String>

The unique name of the requested logical view. Values are of the form projects/<project>/instances/<instance>/logicalViews/<logicalViewId>.

late, final

project ↔ Output<String>

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

late, final

query ↔ Output<String>

The logical view's select query.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {LogicalViewState? state, CustomResourceOptions? options}) → LogicalView

Gets an existing LogicalView resource's state with the given name and id.