Oracle Cloud Infrastructure v1.11.0, Sep 27 23

Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

oci.Nosql.getTable

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testTable = Oci.Nosql.GetTable.Invoke(new()
    {
        TableNameOrId = oci_nosql_table_name_or.Test_table_name_or.Id,
        CompartmentId = @var.Compartment_id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Nosql.GetTable(ctx, &nosql.GetTableArgs{
			TableNameOrId: oci_nosql_table_name_or.Test_table_name_or.Id,
			CompartmentId: _var.Compartment_id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Nosql.NosqlFunctions;
import com.pulumi.oci.Nosql.inputs.GetTableArgs;
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) {
        final var testTable = NosqlFunctions.getTable(GetTableArgs.builder()
            .tableNameOrId(oci_nosql_table_name_or.test_table_name_or().id())
            .compartmentId(var_.compartment_id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_table = oci.Nosql.get_table(table_name_or_id=oci_nosql_table_name_or["test_table_name_or"]["id"],
    compartment_id=var["compartment_id"])

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

const testTable = oci.Nosql.getTable({
    tableNameOrId: oci_nosql_table_name_or.test_table_name_or.id,
    compartmentId: _var.compartment_id,
});

variables:
  testTable:
    fn::invoke:
      Function: oci:Nosql:getTable
      Arguments:
        tableNameOrId: ${oci_nosql_table_name_or.test_table_name_or.id}
        compartmentId: ${var.compartment_id}

Using getTable

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
function getTableOutput(args: GetTableOutputArgs, opts?: InvokeOptions): Output<GetTableResult>

def get_table(compartment_id: Optional[str] = None,
              table_name_or_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(compartment_id: Optional[pulumi.Input[str]] = None,
              table_name_or_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTableResult]

func GetTable(ctx *Context, args *GetTableArgs, opts ...InvokeOption) (*GetTableResult, error)
func GetTableOutput(ctx *Context, args *GetTableOutputArgs, opts ...InvokeOption) GetTableResultOutput

> Note: This function is named GetTable in the Go SDK.

public static class GetTable 
{
    public static Task<GetTableResult> InvokeAsync(GetTableArgs args, InvokeOptions? opts = null)
    public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Nosql/getTable:getTable
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
TableNameOrId string: A table name within the compartment, or a table OCID.

CompartmentId string: The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
TableNameOrId string: A table name within the compartment, or a table OCID.

compartmentId String: The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
tableNameOrId String: A table name within the compartment, or a table OCID.

compartmentId string: The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
tableNameOrId string: A table name within the compartment, or a table OCID.

compartment_id str: The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
table_name_or_id str: A table name within the compartment, or a table OCID.

compartmentId String: The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
tableNameOrId String: A table name within the compartment, or a table OCID.

getTable Result

The following output properties are available:

CompartmentId string: Compartment Identifier.
DdlStatement string: A DDL statement representing the schema.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
FreeformTags Dictionary<string, object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that is immutable.
IsAutoReclaimable bool: True if this table can be reclaimed after an idle period.
LifecycleDetails string: A message describing the current state in more detail.
Name string: The column name.
Schemas List<GetTableSchema>: The table schema information as a JSON object.
State string: The state of a table.
SystemTags Dictionary<string, object>: 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 List<GetTableTableLimit>: Throughput and storage limits configuration of a table.
TableNameOrId string
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: Compartment Identifier.
DdlStatement string: A DDL statement representing the schema.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
FreeformTags map[string]interface{}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that is immutable.
IsAutoReclaimable bool: True if this table can be reclaimed after an idle period.
LifecycleDetails string: A message describing the current state in more detail.
Name string: The column name.
Schemas []GetTableSchema: The table schema information as a JSON object.
State string: The state of a table.
SystemTags map[string]interface{}: 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 []GetTableTableLimit: Throughput and storage limits configuration of a table.
TableNameOrId string
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: Compartment Identifier.
ddlStatement String: A DDL statement representing the schema.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags Map<String,Object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that is immutable.
isAutoReclaimable Boolean: True if this table can be reclaimed after an idle period.
lifecycleDetails String: A message describing the current state in more detail.
name String: The column name.
schemas List<GetTableSchema>: The table schema information as a JSON object.
state String: The state of a table.
systemTags Map<String,Object>: 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 List<GetTableTableLimit>: Throughput and storage limits configuration of a table.
tableNameOrId String
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: Compartment Identifier.
ddlStatement string: A DDL statement representing the schema.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags {[key: string]: any}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier that is immutable.
isAutoReclaimable boolean: True if this table can be reclaimed after an idle period.
lifecycleDetails string: A message describing the current state in more detail.
name string: The column name.
schemas GetTableSchema[]: The table schema information as a JSON object.
state string: The state of a table.
systemTags {[key: string]: any}: 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 GetTableTableLimit[]: Throughput and storage limits configuration of a table.
tableNameOrId string
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: Compartment Identifier.
ddl_statement str: A DDL statement representing the schema.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeform_tags Mapping[str, Any]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Unique identifier that is immutable.
is_auto_reclaimable bool: True if this table can be reclaimed after an idle period.
lifecycle_details str: A message describing the current state in more detail.
name str: The column name.
schemas GetTableSchema]: The table schema information as a JSON object.
state str: The state of a table.
system_tags Mapping[str, Any]: 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 GetTableTableLimit]: Throughput and storage limits configuration of a table.
table_name_or_id str
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: Compartment Identifier.
ddlStatement String: A DDL statement representing the schema.
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
freeformTags Map<Any>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that is immutable.
isAutoReclaimable Boolean: True if this table can be reclaimed after an idle period.
lifecycleDetails String: A message describing the current state in more detail.
name String: The column name.
schemas List<Property Map>: The table schema information as a JSON object.
state String: The state of a table.
systemTags Map<Any>: 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 List<Property Map>: Throughput and storage limits configuration of a table.
tableNameOrId String
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

GetTableSchema

Columns List<GetTableSchemaColumn>: The columns of a table.
Identities List<GetTableSchemaIdentity>: 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 []GetTableSchemaColumn: The columns of a table.
Identities []GetTableSchemaIdentity: 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<GetTableSchemaColumn>: The columns of a table.
identities List<GetTableSchemaIdentity>: 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 GetTableSchemaColumn[]: The columns of a table.
identities GetTableSchemaIdentity[]: 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 GetTableSchemaColumn]: The columns of a table.
identities GetTableSchemaIdentity]: 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.

GetTableSchemaColumn

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: The column 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: The column 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: The column 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: The column 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: The column 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: The column name.
type String: The column type.

GetTableSchemaIdentity

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.

GetTableTableLimit

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.
MaxReadUnits int: Maximum sustained read throughput limit for the table.
MaxStorageInGbs int: Maximum size of storage used by the table.
MaxWriteUnits int: Maximum sustained write throughput limit for the 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.
MaxReadUnits int: Maximum sustained read throughput limit for the table.
MaxStorageInGbs int: Maximum size of storage used by the table.
MaxWriteUnits int: Maximum sustained write throughput limit for the 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.
maxReadUnits Integer: Maximum sustained read throughput limit for the table.
maxStorageInGbs Integer: Maximum size of storage used by the table.
maxWriteUnits Integer: Maximum sustained write throughput limit for the 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.
maxReadUnits number: Maximum sustained read throughput limit for the table.
maxStorageInGbs number: Maximum size of storage used by the table.
maxWriteUnits number: Maximum sustained write throughput limit for the 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.
max_read_units int: Maximum sustained read throughput limit for the table.
max_storage_in_gbs int: Maximum size of storage used by the table.
max_write_units int: Maximum sustained write throughput limit for the 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.
maxReadUnits Number: Maximum sustained read throughput limit for the table.
maxStorageInGbs Number: Maximum size of storage used by the table.
maxWriteUnits Number: Maximum sustained write throughput limit for the table.

Package Details

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

Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

pulumi/pulumi-oci

oci.Nosql.getTable

On this page

On this page

Example Usage

Using getTable

getTable Result

Supporting Types

GetTableSchema

GetTableSchemaColumn

GetTableSchemaIdentity

GetTableTableLimit

Package Details

On this page

On this page