1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Nosql
  5. Table
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Nosql.Table

Explore with Pulumi AI

This resource provides the Table resource in Oracle Cloud Infrastructure NoSQL Database service.

Create a new table.

Example Usage

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

const testTable = new oci.nosql.Table("test_table", {
    compartmentId: compartmentId,
    ddlStatement: tableDdlStatement,
    name: tableName,
    definedTags: tableDefinedTags,
    freeformTags: {
        "bar-key": "value",
    },
    isAutoReclaimable: tableIsAutoReclaimable,
    tableLimits: {
        maxReadUnits: tableTableLimitsMaxReadUnits,
        maxStorageInGbs: tableTableLimitsMaxStorageInGbs,
        maxWriteUnits: tableTableLimitsMaxWriteUnits,
        capacityMode: tableTableLimitsCapacityMode,
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_table = oci.nosql.Table("test_table",
    compartment_id=compartment_id,
    ddl_statement=table_ddl_statement,
    name=table_name,
    defined_tags=table_defined_tags,
    freeform_tags={
        "bar-key": "value",
    },
    is_auto_reclaimable=table_is_auto_reclaimable,
    table_limits={
        "max_read_units": table_table_limits_max_read_units,
        "max_storage_in_gbs": table_table_limits_max_storage_in_gbs,
        "max_write_units": table_table_limits_max_write_units,
        "capacity_mode": table_table_limits_capacity_mode,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/nosql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nosql.NewTable(ctx, "test_table", &nosql.TableArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DdlStatement:  pulumi.Any(tableDdlStatement),
			Name:          pulumi.Any(tableName),
			DefinedTags:   pulumi.Any(tableDefinedTags),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			IsAutoReclaimable: pulumi.Any(tableIsAutoReclaimable),
			TableLimits: &nosql.TableTableLimitsArgs{
				MaxReadUnits:    pulumi.Any(tableTableLimitsMaxReadUnits),
				MaxStorageInGbs: pulumi.Any(tableTableLimitsMaxStorageInGbs),
				MaxWriteUnits:   pulumi.Any(tableTableLimitsMaxWriteUnits),
				CapacityMode:    pulumi.Any(tableTableLimitsCapacityMode),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testTable = new Oci.Nosql.Table("test_table", new()
    {
        CompartmentId = compartmentId,
        DdlStatement = tableDdlStatement,
        Name = tableName,
        DefinedTags = tableDefinedTags,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        IsAutoReclaimable = tableIsAutoReclaimable,
        TableLimits = new Oci.Nosql.Inputs.TableTableLimitsArgs
        {
            MaxReadUnits = tableTableLimitsMaxReadUnits,
            MaxStorageInGbs = tableTableLimitsMaxStorageInGbs,
            MaxWriteUnits = tableTableLimitsMaxWriteUnits,
            CapacityMode = tableTableLimitsCapacityMode,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Nosql.Table;
import com.pulumi.oci.Nosql.TableArgs;
import com.pulumi.oci.Nosql.inputs.TableTableLimitsArgs;
import java.util.List;
import java.util.ArrayList;
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 testTable = new Table("testTable", TableArgs.builder()
            .compartmentId(compartmentId)
            .ddlStatement(tableDdlStatement)
            .name(tableName)
            .definedTags(tableDefinedTags)
            .freeformTags(Map.of("bar-key", "value"))
            .isAutoReclaimable(tableIsAutoReclaimable)
            .tableLimits(TableTableLimitsArgs.builder()
                .maxReadUnits(tableTableLimitsMaxReadUnits)
                .maxStorageInGbs(tableTableLimitsMaxStorageInGbs)
                .maxWriteUnits(tableTableLimitsMaxWriteUnits)
                .capacityMode(tableTableLimitsCapacityMode)
                .build())
            .build());

    }
}
Copy
resources:
  testTable:
    type: oci:Nosql:Table
    name: test_table
    properties:
      compartmentId: ${compartmentId}
      ddlStatement: ${tableDdlStatement}
      name: ${tableName}
      definedTags: ${tableDefinedTags}
      freeformTags:
        bar-key: value
      isAutoReclaimable: ${tableIsAutoReclaimable}
      tableLimits:
        maxReadUnits: ${tableTableLimitsMaxReadUnits}
        maxStorageInGbs: ${tableTableLimitsMaxStorageInGbs}
        maxWriteUnits: ${tableTableLimitsMaxWriteUnits}
        capacityMode: ${tableTableLimitsCapacityMode}
Copy

Create Table Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);
@overload
def Table(resource_name: str,
          args: TableArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Table(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          compartment_id: Optional[str] = None,
          ddl_statement: Optional[str] = None,
          defined_tags: Optional[Mapping[str, str]] = None,
          freeform_tags: Optional[Mapping[str, str]] = None,
          is_auto_reclaimable: Optional[bool] = None,
          name: Optional[str] = None,
          table_limits: Optional[_nosql.TableTableLimitsArgs] = None)
func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)
public Table(string name, TableArgs args, CustomResourceOptions? opts = null)
public Table(String name, TableArgs args)
public Table(String name, TableArgs args, CustomResourceOptions options)
type: oci:Nosql:Table
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var tableResource = new Oci.Nosql.Table("tableResource", new()
{
    CompartmentId = "string",
    DdlStatement = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsAutoReclaimable = false,
    Name = "string",
    TableLimits = new Oci.Nosql.Inputs.TableTableLimitsArgs
    {
        MaxReadUnits = 0,
        MaxStorageInGbs = 0,
        MaxWriteUnits = 0,
        CapacityMode = "string",
    },
});
Copy
example, err := nosql.NewTable(ctx, "tableResource", &nosql.TableArgs{
	CompartmentId: pulumi.String("string"),
	DdlStatement:  pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsAutoReclaimable: pulumi.Bool(false),
	Name:              pulumi.String("string"),
	TableLimits: &nosql.TableTableLimitsArgs{
		MaxReadUnits:    pulumi.Int(0),
		MaxStorageInGbs: pulumi.Int(0),
		MaxWriteUnits:   pulumi.Int(0),
		CapacityMode:    pulumi.String("string"),
	},
})
Copy
var tableResource = new Table("tableResource", TableArgs.builder()
    .compartmentId("string")
    .ddlStatement("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .isAutoReclaimable(false)
    .name("string")
    .tableLimits(TableTableLimitsArgs.builder()
        .maxReadUnits(0)
        .maxStorageInGbs(0)
        .maxWriteUnits(0)
        .capacityMode("string")
        .build())
    .build());
Copy
table_resource = oci.nosql.Table("tableResource",
    compartment_id="string",
    ddl_statement="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    is_auto_reclaimable=False,
    name="string",
    table_limits={
        "max_read_units": 0,
        "max_storage_in_gbs": 0,
        "max_write_units": 0,
        "capacity_mode": "string",
    })
Copy
const tableResource = new oci.nosql.Table("tableResource", {
    compartmentId: "string",
    ddlStatement: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    isAutoReclaimable: false,
    name: "string",
    tableLimits: {
        maxReadUnits: 0,
        maxStorageInGbs: 0,
        maxWriteUnits: 0,
        capacityMode: "string",
    },
});
Copy
type: oci:Nosql:Table
properties:
    compartmentId: string
    ddlStatement: string
    definedTags:
        string: string
    freeformTags:
        string: string
    isAutoReclaimable: false
    name: string
    tableLimits:
        capacityMode: string
        maxReadUnits: 0
        maxStorageInGbs: 0
        maxWriteUnits: 0
Copy

Table Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Table resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) Compartment Identifier.
DdlStatement This property is required. string
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsAutoReclaimable Changes to this property will trigger replacement. bool
True if table can be reclaimed after an idle period.
Name Changes to this property will trigger replacement. string
Table name.
TableLimits TableTableLimits
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
CompartmentId This property is required. string
(Updatable) Compartment Identifier.
DdlStatement This property is required. string
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsAutoReclaimable Changes to this property will trigger replacement. bool
True if table can be reclaimed after an idle period.
Name Changes to this property will trigger replacement. string
Table name.
TableLimits TableTableLimitsArgs
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
compartmentId This property is required. String
(Updatable) Compartment Identifier.
ddlStatement This property is required. String
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoReclaimable Changes to this property will trigger replacement. Boolean
True if table can be reclaimed after an idle period.
name Changes to this property will trigger replacement. String
Table name.
tableLimits TableTableLimits
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
compartmentId This property is required. string
(Updatable) Compartment Identifier.
ddlStatement This property is required. string
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoReclaimable Changes to this property will trigger replacement. boolean
True if table can be reclaimed after an idle period.
name Changes to this property will trigger replacement. string
Table name.
tableLimits TableTableLimits
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
compartment_id This property is required. str
(Updatable) Compartment Identifier.
ddl_statement This property is required. str
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
is_auto_reclaimable Changes to this property will trigger replacement. bool
True if table can be reclaimed after an idle period.
name Changes to this property will trigger replacement. str
Table name.
table_limits nosql.TableTableLimitsArgs
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
compartmentId This property is required. String
(Updatable) Compartment Identifier.
ddlStatement This property is required. String
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoReclaimable Changes to this property will trigger replacement. Boolean
True if table can be reclaimed after an idle period.
name Changes to this property will trigger replacement. String
Table name.
tableLimits Property Map
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.

Outputs

All input properties are implicitly available as output properties. Additionally, the Table resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
IsMultiRegion bool
True if this table is currently a member of a replication set.
LifecycleDetails string
A message describing the current state in more detail.
LocalReplicaInitializationInPercent int
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
Replicas List<TableReplica>
An array of Replica listing this table's replicas, if any
SchemaState string
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
Schemas List<TableSchema>
The table schema information as a JSON object.
State string
The state of a table.
SystemTags Dictionary<string, string>
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
TimeCreated string
The time the the table was created. An RFC3339 formatted datetime string.
TimeOfExpiration string
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
TimeUpdated string
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
Id string
The provider-assigned unique ID for this managed resource.
IsMultiRegion bool
True if this table is currently a member of a replication set.
LifecycleDetails string
A message describing the current state in more detail.
LocalReplicaInitializationInPercent int
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
Replicas []TableReplicaType
An array of Replica listing this table's replicas, if any
SchemaState string
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
Schemas []TableSchema
The table schema information as a JSON object.
State string
The state of a table.
SystemTags map[string]string
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
TimeCreated string
The time the the table was created. An RFC3339 formatted datetime string.
TimeOfExpiration string
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
TimeUpdated string
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
id String
The provider-assigned unique ID for this managed resource.
isMultiRegion Boolean
True if this table is currently a member of a replication set.
lifecycleDetails String
A message describing the current state in more detail.
localReplicaInitializationInPercent Integer
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
replicas List<TableReplica>
An array of Replica listing this table's replicas, if any
schemaState String
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
schemas List<TableSchema>
The table schema information as a JSON object.
state String
The state of a table.
systemTags Map<String,String>
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
timeCreated String
The time the the table was created. An RFC3339 formatted datetime string.
timeOfExpiration String
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
timeUpdated String
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
id string
The provider-assigned unique ID for this managed resource.
isMultiRegion boolean
True if this table is currently a member of a replication set.
lifecycleDetails string
A message describing the current state in more detail.
localReplicaInitializationInPercent number
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
replicas TableReplica[]
An array of Replica listing this table's replicas, if any
schemaState string
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
schemas TableSchema[]
The table schema information as a JSON object.
state string
The state of a table.
systemTags {[key: string]: string}
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
timeCreated string
The time the the table was created. An RFC3339 formatted datetime string.
timeOfExpiration string
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
timeUpdated string
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
id str
The provider-assigned unique ID for this managed resource.
is_multi_region bool
True if this table is currently a member of a replication set.
lifecycle_details str
A message describing the current state in more detail.
local_replica_initialization_in_percent int
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
replicas Sequence[nosql.TableReplica]
An array of Replica listing this table's replicas, if any
schema_state str
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
schemas Sequence[nosql.TableSchema]
The table schema information as a JSON object.
state str
The state of a table.
system_tags Mapping[str, str]
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
time_created str
The time the the table was created. An RFC3339 formatted datetime string.
time_of_expiration str
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
time_updated str
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
id String
The provider-assigned unique ID for this managed resource.
isMultiRegion Boolean
True if this table is currently a member of a replication set.
lifecycleDetails String
A message describing the current state in more detail.
localReplicaInitializationInPercent Number
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
replicas List<Property Map>
An array of Replica listing this table's replicas, if any
schemaState String
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
schemas List<Property Map>
The table schema information as a JSON object.
state String
The state of a table.
systemTags Map<String>
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
timeCreated String
The time the the table was created. An RFC3339 formatted datetime string.
timeOfExpiration String
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
timeUpdated String
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.

Look up Existing Table Resource

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

public static get(name: string, id: Input<ID>, state?: TableState, opts?: CustomResourceOptions): Table
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        ddl_statement: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_auto_reclaimable: Optional[bool] = None,
        is_multi_region: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        local_replica_initialization_in_percent: Optional[int] = None,
        name: Optional[str] = None,
        replicas: Optional[Sequence[_nosql.TableReplicaArgs]] = None,
        schema_state: Optional[str] = None,
        schemas: Optional[Sequence[_nosql.TableSchemaArgs]] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        table_limits: Optional[_nosql.TableTableLimitsArgs] = None,
        time_created: Optional[str] = None,
        time_of_expiration: Optional[str] = None,
        time_updated: Optional[str] = None) -> Table
func GetTable(ctx *Context, name string, id IDInput, state *TableState, opts ...ResourceOption) (*Table, error)
public static Table Get(string name, Input<string> id, TableState? state, CustomResourceOptions? opts = null)
public static Table get(String name, Output<String> id, TableState state, CustomResourceOptions options)
resources:  _:    type: oci:Nosql:Table    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string
(Updatable) Compartment Identifier.
DdlStatement string
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsAutoReclaimable Changes to this property will trigger replacement. bool
True if table can be reclaimed after an idle period.
IsMultiRegion bool
True if this table is currently a member of a replication set.
LifecycleDetails string
A message describing the current state in more detail.
LocalReplicaInitializationInPercent int
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
Name Changes to this property will trigger replacement. string
Table name.
Replicas List<TableReplica>
An array of Replica listing this table's replicas, if any
SchemaState string
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
Schemas List<TableSchema>
The table schema information as a JSON object.
State string
The state of a table.
SystemTags Dictionary<string, string>
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
TableLimits TableTableLimits
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
TimeCreated string
The time the the table was created. An RFC3339 formatted datetime string.
TimeOfExpiration string
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
TimeUpdated string
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
CompartmentId string
(Updatable) Compartment Identifier.
DdlStatement string
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsAutoReclaimable Changes to this property will trigger replacement. bool
True if table can be reclaimed after an idle period.
IsMultiRegion bool
True if this table is currently a member of a replication set.
LifecycleDetails string
A message describing the current state in more detail.
LocalReplicaInitializationInPercent int
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
Name Changes to this property will trigger replacement. string
Table name.
Replicas []TableReplicaTypeArgs
An array of Replica listing this table's replicas, if any
SchemaState string
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
Schemas []TableSchemaArgs
The table schema information as a JSON object.
State string
The state of a table.
SystemTags map[string]string
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
TableLimits TableTableLimitsArgs
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
TimeCreated string
The time the the table was created. An RFC3339 formatted datetime string.
TimeOfExpiration string
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
TimeUpdated string
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
compartmentId String
(Updatable) Compartment Identifier.
ddlStatement String
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoReclaimable Changes to this property will trigger replacement. Boolean
True if table can be reclaimed after an idle period.
isMultiRegion Boolean
True if this table is currently a member of a replication set.
lifecycleDetails String
A message describing the current state in more detail.
localReplicaInitializationInPercent Integer
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
name Changes to this property will trigger replacement. String
Table name.
replicas List<TableReplica>
An array of Replica listing this table's replicas, if any
schemaState String
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
schemas List<TableSchema>
The table schema information as a JSON object.
state String
The state of a table.
systemTags Map<String,String>
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
tableLimits TableTableLimits
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
timeCreated String
The time the the table was created. An RFC3339 formatted datetime string.
timeOfExpiration String
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
timeUpdated String
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
compartmentId string
(Updatable) Compartment Identifier.
ddlStatement string
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoReclaimable Changes to this property will trigger replacement. boolean
True if table can be reclaimed after an idle period.
isMultiRegion boolean
True if this table is currently a member of a replication set.
lifecycleDetails string
A message describing the current state in more detail.
localReplicaInitializationInPercent number
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
name Changes to this property will trigger replacement. string
Table name.
replicas TableReplica[]
An array of Replica listing this table's replicas, if any
schemaState string
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
schemas TableSchema[]
The table schema information as a JSON object.
state string
The state of a table.
systemTags {[key: string]: string}
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
tableLimits TableTableLimits
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
timeCreated string
The time the the table was created. An RFC3339 formatted datetime string.
timeOfExpiration string
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
timeUpdated string
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
compartment_id str
(Updatable) Compartment Identifier.
ddl_statement str
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
is_auto_reclaimable Changes to this property will trigger replacement. bool
True if table can be reclaimed after an idle period.
is_multi_region bool
True if this table is currently a member of a replication set.
lifecycle_details str
A message describing the current state in more detail.
local_replica_initialization_in_percent int
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
name Changes to this property will trigger replacement. str
Table name.
replicas Sequence[nosql.TableReplicaArgs]
An array of Replica listing this table's replicas, if any
schema_state str
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
schemas Sequence[nosql.TableSchemaArgs]
The table schema information as a JSON object.
state str
The state of a table.
system_tags Mapping[str, str]
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
table_limits nosql.TableTableLimitsArgs
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
time_created str
The time the the table was created. An RFC3339 formatted datetime string.
time_of_expiration str
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
time_updated str
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
compartmentId String
(Updatable) Compartment Identifier.
ddlStatement String
(Updatable) Complete CREATE TABLE DDL statement. When update ddl_statement, it should be ALTER TABLE DDL statement.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoReclaimable Changes to this property will trigger replacement. Boolean
True if table can be reclaimed after an idle period.
isMultiRegion Boolean
True if this table is currently a member of a replication set.
lifecycleDetails String
A message describing the current state in more detail.
localReplicaInitializationInPercent Number
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
name Changes to this property will trigger replacement. String
Table name.
replicas List<Property Map>
An array of Replica listing this table's replicas, if any
schemaState String
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
schemas List<Property Map>
The table schema information as a JSON object.
state String
The state of a table.
systemTags Map<String>
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is "orcl-cloud"; and the only key in that namespace is "free-tier-retained". Example: {"orcl-cloud"": {"free-tier-retained": "true"}}
tableLimits Property Map
(Updatable) Throughput and storage limits configuration of a table. It is required for top level table, must be null for child table as child table shares its top parent table's limits.
timeCreated String
The time the the table was created. An RFC3339 formatted datetime string.
timeOfExpiration String
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
timeUpdated String
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.

Supporting Types

TableReplica
, TableReplicaArgs

CapacityMode string
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
LifecycleDetails string
A message describing the current state in more detail.
MaxWriteUnits int
Maximum sustained write throughput limit for the table.
Region string
A customer-facing region identifier
State string
The state of a table.
TableId string
The OCID of the replica table
CapacityMode string
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
LifecycleDetails string
A message describing the current state in more detail.
MaxWriteUnits int
Maximum sustained write throughput limit for the table.
Region string
A customer-facing region identifier
State string
The state of a table.
TableId string
The OCID of the replica table
capacityMode String
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
lifecycleDetails String
A message describing the current state in more detail.
maxWriteUnits Integer
Maximum sustained write throughput limit for the table.
region String
A customer-facing region identifier
state String
The state of a table.
tableId String
The OCID of the replica table
capacityMode string
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
lifecycleDetails string
A message describing the current state in more detail.
maxWriteUnits number
Maximum sustained write throughput limit for the table.
region string
A customer-facing region identifier
state string
The state of a table.
tableId string
The OCID of the replica table
capacity_mode str
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
lifecycle_details str
A message describing the current state in more detail.
max_write_units int
Maximum sustained write throughput limit for the table.
region str
A customer-facing region identifier
state str
The state of a table.
table_id str
The OCID of the replica table
capacityMode String
The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
lifecycleDetails String
A message describing the current state in more detail.
maxWriteUnits Number
Maximum sustained write throughput limit for the table.
region String
A customer-facing region identifier
state String
The state of a table.
tableId String
The OCID of the replica table

TableSchema
, TableSchemaArgs

Columns List<TableSchemaColumn>
The columns of a table.
Identities List<TableSchemaIdentity>
The identity properties of a table, if any.
PrimaryKeys List<string>
A list of column names that make up a key.
ShardKeys List<string>
A list of column names that make up a key.
Ttl int
The default Time-to-Live for the table, in days.
Columns []TableSchemaColumn
The columns of a table.
Identities []TableSchemaIdentity
The identity properties of a table, if any.
PrimaryKeys []string
A list of column names that make up a key.
ShardKeys []string
A list of column names that make up a key.
Ttl int
The default Time-to-Live for the table, in days.
columns List<TableSchemaColumn>
The columns of a table.
identities List<TableSchemaIdentity>
The identity properties of a table, if any.
primaryKeys List<String>
A list of column names that make up a key.
shardKeys List<String>
A list of column names that make up a key.
ttl Integer
The default Time-to-Live for the table, in days.
columns TableSchemaColumn[]
The columns of a table.
identities TableSchemaIdentity[]
The identity properties of a table, if any.
primaryKeys string[]
A list of column names that make up a key.
shardKeys string[]
A list of column names that make up a key.
ttl number
The default Time-to-Live for the table, in days.
columns Sequence[nosql.TableSchemaColumn]
The columns of a table.
identities Sequence[nosql.TableSchemaIdentity]
The identity properties of a table, if any.
primary_keys Sequence[str]
A list of column names that make up a key.
shard_keys Sequence[str]
A list of column names that make up a key.
ttl int
The default Time-to-Live for the table, in days.
columns List<Property Map>
The columns of a table.
identities List<Property Map>
The identity properties of a table, if any.
primaryKeys List<String>
A list of column names that make up a key.
shardKeys List<String>
A list of column names that make up a key.
ttl Number
The default Time-to-Live for the table, in days.

TableSchemaColumn
, TableSchemaColumnArgs

DefaultValue string
The column default value.
IsAsUuid bool
True if the STRING column was declared AS UUID.
IsGenerated bool
True if the STRING AS UUID column is also GENERATED BY DEFAULT.
IsNullable bool
The column nullable flag.
Name string
Table name.
Type string
The column type.
DefaultValue string
The column default value.
IsAsUuid bool
True if the STRING column was declared AS UUID.
IsGenerated bool
True if the STRING AS UUID column is also GENERATED BY DEFAULT.
IsNullable bool
The column nullable flag.
Name string
Table name.
Type string
The column type.
defaultValue String
The column default value.
isAsUuid Boolean
True if the STRING column was declared AS UUID.
isGenerated Boolean
True if the STRING AS UUID column is also GENERATED BY DEFAULT.
isNullable Boolean
The column nullable flag.
name String
Table name.
type String
The column type.
defaultValue string
The column default value.
isAsUuid boolean
True if the STRING column was declared AS UUID.
isGenerated boolean
True if the STRING AS UUID column is also GENERATED BY DEFAULT.
isNullable boolean
The column nullable flag.
name string
Table name.
type string
The column type.
default_value str
The column default value.
is_as_uuid bool
True if the STRING column was declared AS UUID.
is_generated bool
True if the STRING AS UUID column is also GENERATED BY DEFAULT.
is_nullable bool
The column nullable flag.
name str
Table name.
type str
The column type.
defaultValue String
The column default value.
isAsUuid Boolean
True if the STRING column was declared AS UUID.
isGenerated Boolean
True if the STRING AS UUID column is also GENERATED BY DEFAULT.
isNullable Boolean
The column nullable flag.
name String
Table name.
type String
The column type.

TableSchemaIdentity
, TableSchemaIdentityArgs

ColumnName string
The name of the identity column.
IsAlways bool
True if the identity value is GENERATED ALWAYS.
IsNull bool
True if the identity value is GENERATED BY DEFAULT ON NULL.
ColumnName string
The name of the identity column.
IsAlways bool
True if the identity value is GENERATED ALWAYS.
IsNull bool
True if the identity value is GENERATED BY DEFAULT ON NULL.
columnName String
The name of the identity column.
isAlways Boolean
True if the identity value is GENERATED ALWAYS.
isNull Boolean
True if the identity value is GENERATED BY DEFAULT ON NULL.
columnName string
The name of the identity column.
isAlways boolean
True if the identity value is GENERATED ALWAYS.
isNull boolean
True if the identity value is GENERATED BY DEFAULT ON NULL.
column_name str
The name of the identity column.
is_always bool
True if the identity value is GENERATED ALWAYS.
is_null bool
True if the identity value is GENERATED BY DEFAULT ON NULL.
columnName String
The name of the identity column.
isAlways Boolean
True if the identity value is GENERATED ALWAYS.
isNull Boolean
True if the identity value is GENERATED BY DEFAULT ON NULL.

TableTableLimits
, TableTableLimitsArgs

MaxReadUnits This property is required. int
(Updatable) Maximum sustained read throughput limit for the table.
MaxStorageInGbs This property is required. int
(Updatable) Maximum size of storage used by the table.
MaxWriteUnits This property is required. int

(Updatable) Maximum sustained write throughput limit for the table.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CapacityMode string
(Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
MaxReadUnits This property is required. int
(Updatable) Maximum sustained read throughput limit for the table.
MaxStorageInGbs This property is required. int
(Updatable) Maximum size of storage used by the table.
MaxWriteUnits This property is required. int

(Updatable) Maximum sustained write throughput limit for the table.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CapacityMode string
(Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
maxReadUnits This property is required. Integer
(Updatable) Maximum sustained read throughput limit for the table.
maxStorageInGbs This property is required. Integer
(Updatable) Maximum size of storage used by the table.
maxWriteUnits This property is required. Integer

(Updatable) Maximum sustained write throughput limit for the table.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

capacityMode String
(Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
maxReadUnits This property is required. number
(Updatable) Maximum sustained read throughput limit for the table.
maxStorageInGbs This property is required. number
(Updatable) Maximum size of storage used by the table.
maxWriteUnits This property is required. number

(Updatable) Maximum sustained write throughput limit for the table.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

capacityMode string
(Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
max_read_units This property is required. int
(Updatable) Maximum sustained read throughput limit for the table.
max_storage_in_gbs This property is required. int
(Updatable) Maximum size of storage used by the table.
max_write_units This property is required. int

(Updatable) Maximum sustained write throughput limit for the table.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

capacity_mode str
(Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.
maxReadUnits This property is required. Number
(Updatable) Maximum sustained read throughput limit for the table.
maxStorageInGbs This property is required. Number
(Updatable) Maximum size of storage used by the table.
maxWriteUnits This property is required. Number

(Updatable) Maximum sustained write throughput limit for the table.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

capacityMode String
(Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.

Import

Tables can be imported using the id, e.g.

$ pulumi import oci:Nosql/table:Table test_table "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.