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.getTables

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 testTables = Oci.Nosql.GetTables.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        Name = @var.Table_name,
        State = @var.Table_state,
    });

});

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.GetTables(ctx, &nosql.GetTablesArgs{
			CompartmentId: _var.Compartment_id,
			Name:          pulumi.StringRef(_var.Table_name),
			State:         pulumi.StringRef(_var.Table_state),
		}, 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.GetTablesArgs;
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 testTables = NosqlFunctions.getTables(GetTablesArgs.builder()
            .compartmentId(var_.compartment_id())
            .name(var_.table_name())
            .state(var_.table_state())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_tables = oci.Nosql.get_tables(compartment_id=var["compartment_id"],
    name=var["table_name"],
    state=var["table_state"])

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

const testTables = oci.Nosql.getTables({
    compartmentId: _var.compartment_id,
    name: _var.table_name,
    state: _var.table_state,
});

variables:
  testTables:
    fn::invoke:
      Function: oci:Nosql:getTables
      Arguments:
        compartmentId: ${var.compartment_id}
        name: ${var.table_name}
        state: ${var.table_state}

Using getTables

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 getTables(args: GetTablesArgs, opts?: InvokeOptions): Promise<GetTablesResult>
function getTablesOutput(args: GetTablesOutputArgs, opts?: InvokeOptions): Output<GetTablesResult>

def get_tables(compartment_id: Optional[str] = None,
               filters: Optional[Sequence[_nosql.GetTablesFilter]] = None,
               name: Optional[str] = None,
               state: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetTablesResult
def get_tables_output(compartment_id: Optional[pulumi.Input[str]] = None,
               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_nosql.GetTablesFilterArgs]]]] = None,
               name: Optional[pulumi.Input[str]] = None,
               state: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetTablesResult]

func GetTables(ctx *Context, args *GetTablesArgs, opts ...InvokeOption) (*GetTablesResult, error)
func GetTablesOutput(ctx *Context, args *GetTablesOutputArgs, opts ...InvokeOption) GetTablesResultOutput

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

public static class GetTables 
{
    public static Task<GetTablesResult> InvokeAsync(GetTablesArgs args, InvokeOptions? opts = null)
    public static Output<GetTablesResult> Invoke(GetTablesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTablesResult> getTables(GetTablesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

CompartmentId string: The ID of a table's compartment.
Filters List<GetTablesFilter>
Name string: A shell-globbing-style (*?[]) filter for names.
State string: Filter list by the lifecycle state of the item.

CompartmentId string: The ID of a table's compartment.
Filters []GetTablesFilter
Name string: A shell-globbing-style (*?[]) filter for names.
State string: Filter list by the lifecycle state of the item.

compartmentId String: The ID of a table's compartment.
filters List<GetTablesFilter>
name String: A shell-globbing-style (*?[]) filter for names.
state String: Filter list by the lifecycle state of the item.

compartmentId string: The ID of a table's compartment.
filters GetTablesFilter[]
name string: A shell-globbing-style (*?[]) filter for names.
state string: Filter list by the lifecycle state of the item.

compartment_id str: The ID of a table's compartment.
filters GetTablesFilter]
name str: A shell-globbing-style (*?[]) filter for names.
state str: Filter list by the lifecycle state of the item.

compartmentId String: The ID of a table's compartment.
filters List<Property Map>
name String: A shell-globbing-style (*?[]) filter for names.
state String: Filter list by the lifecycle state of the item.

getTables Result

The following output properties are available:

CompartmentId string: Compartment Identifier.
Id string: The provider-assigned unique ID for this managed resource.
TableCollections List<GetTablesTableCollection>: The list of table_collection.
Filters List<GetTablesFilter>
Name string: Human-friendly table name, immutable.
State string: The state of a table.

CompartmentId string: Compartment Identifier.
Id string: The provider-assigned unique ID for this managed resource.
TableCollections []GetTablesTableCollection: The list of table_collection.
Filters []GetTablesFilter
Name string: Human-friendly table name, immutable.
State string: The state of a table.

compartmentId String: Compartment Identifier.
id String: The provider-assigned unique ID for this managed resource.
tableCollections List<GetTablesTableCollection>: The list of table_collection.
filters List<GetTablesFilter>
name String: Human-friendly table name, immutable.
state String: The state of a table.

compartmentId string: Compartment Identifier.
id string: The provider-assigned unique ID for this managed resource.
tableCollections GetTablesTableCollection[]: The list of table_collection.
filters GetTablesFilter[]
name string: Human-friendly table name, immutable.
state string: The state of a table.

compartment_id str: Compartment Identifier.
id str: The provider-assigned unique ID for this managed resource.
table_collections GetTablesTableCollection]: The list of table_collection.
filters GetTablesFilter]
name str: Human-friendly table name, immutable.
state str: The state of a table.

compartmentId String: Compartment Identifier.
id String: The provider-assigned unique ID for this managed resource.
tableCollections List<Property Map>: The list of table_collection.
filters List<Property Map>
name String: Human-friendly table name, immutable.
state String: The state of a table.

Supporting Types

GetTablesFilter

Name string: A shell-globbing-style (*?[]) filter for names.
Values List<string>
Regex bool

Name string: A shell-globbing-style (*?[]) filter for names.
Values []string
Regex bool

name String: A shell-globbing-style (*?[]) filter for names.
values List<String>
regex Boolean

name string: A shell-globbing-style (*?[]) filter for names.
values string[]
regex boolean

name str: A shell-globbing-style (*?[]) filter for names.
values Sequence[str]
regex bool

name String: A shell-globbing-style (*?[]) filter for names.
values List<String>
regex Boolean

GetTablesTableCollection

CompartmentId string: The ID of a table's compartment.
DdlStatement string
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: A shell-globbing-style (*?[]) filter for names.
Schemas List<GetTablesTableCollectionSchema>
State string: Filter list by the lifecycle state of the item.
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<GetTablesTableCollectionTableLimit>: Throughput and storage limits configuration of a table.
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: The ID of a table's compartment.
DdlStatement string
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: A shell-globbing-style (*?[]) filter for names.
Schemas []GetTablesTableCollectionSchema
State string: Filter list by the lifecycle state of the item.
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 []GetTablesTableCollectionTableLimit: Throughput and storage limits configuration of a table.
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: The ID of a table's compartment.
ddlStatement String
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: A shell-globbing-style (*?[]) filter for names.
schemas List<GetTablesTableCollectionSchema>
state String: Filter list by the lifecycle state of the item.
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<GetTablesTableCollectionTableLimit>: Throughput and storage limits configuration of a table.
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: The ID of a table's compartment.
ddlStatement string
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: A shell-globbing-style (*?[]) filter for names.
schemas GetTablesTableCollectionSchema[]
state string: Filter list by the lifecycle state of the item.
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 GetTablesTableCollectionTableLimit[]: Throughput and storage limits configuration of a table.
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: The ID of a table's compartment.
ddl_statement str
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: A shell-globbing-style (*?[]) filter for names.
schemas GetTablesTableCollectionSchema]
state str: Filter list by the lifecycle state of the item.
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 GetTablesTableCollectionTableLimit]: Throughput and storage limits configuration of a table.
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: The ID of a table's compartment.
ddlStatement String
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: A shell-globbing-style (*?[]) filter for names.
schemas List<Property Map>
state String: Filter list by the lifecycle state of the item.
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.
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.

GetTablesTableCollectionSchema

Columns List<GetTablesTableCollectionSchemaColumn>
Identities List<GetTablesTableCollectionSchemaIdentity>
PrimaryKeys List<string>
ShardKeys List<string>
Ttl int

Columns []GetTablesTableCollectionSchemaColumn
Identities []GetTablesTableCollectionSchemaIdentity
PrimaryKeys []string
ShardKeys []string
Ttl int

columns List<GetTablesTableCollectionSchemaColumn>
identities List<GetTablesTableCollectionSchemaIdentity>
primaryKeys List<String>
shardKeys List<String>
ttl Integer

columns GetTablesTableCollectionSchemaColumn[]
identities GetTablesTableCollectionSchemaIdentity[]
primaryKeys string[]
shardKeys string[]
ttl number

columns GetTablesTableCollectionSchemaColumn]
identities GetTablesTableCollectionSchemaIdentity]
primary_keys Sequence[str]
shard_keys Sequence[str]
ttl int

columns List<Property Map>
identities List<Property Map>
primaryKeys List<String>
shardKeys List<String>
ttl Number

GetTablesTableCollectionSchemaColumn

DefaultValue string
IsAsUuid bool
IsGenerated bool
IsNullable bool
Name string: A shell-globbing-style (*?[]) filter for names.
Type string

DefaultValue string
IsAsUuid bool
IsGenerated bool
IsNullable bool
Name string: A shell-globbing-style (*?[]) filter for names.
Type string

defaultValue String
isAsUuid Boolean
isGenerated Boolean
isNullable Boolean
name String: A shell-globbing-style (*?[]) filter for names.
type String

defaultValue string
isAsUuid boolean
isGenerated boolean
isNullable boolean
name string: A shell-globbing-style (*?[]) filter for names.
type string

default_value str
is_as_uuid bool
is_generated bool
is_nullable bool
name str: A shell-globbing-style (*?[]) filter for names.
type str

defaultValue String
isAsUuid Boolean
isGenerated Boolean
isNullable Boolean
name String: A shell-globbing-style (*?[]) filter for names.
type String

GetTablesTableCollectionSchemaIdentity

ColumnName string
IsAlways bool
IsNull bool

ColumnName string
IsAlways bool
IsNull bool

columnName String
isAlways Boolean
isNull Boolean

columnName string
isAlways boolean
isNull boolean

column_name str
is_always bool
is_null bool

columnName String
isAlways Boolean
isNull Boolean

GetTablesTableCollectionTableLimit

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.getTables

On this page

On this page

Example Usage

Using getTables

getTables Result

Supporting Types

GetTablesFilter

GetTablesTableCollection

GetTablesTableCollectionSchema

GetTablesTableCollectionSchemaColumn

GetTablesTableCollectionSchemaIdentity

GetTablesTableCollectionTableLimit

Package Details

On this page

On this page