Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
oci.Nosql.getTables
Start a Neo task
Explain and create an oci.Nosql.getTables resource
This data source provides the list of Tables in Oracle Cloud Infrastructure NoSQL Database service.
Get a list of tables in a compartment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testTables = oci.Nosql.getTables({
compartmentId: compartmentId,
name: tableName,
state: tableState,
});
import pulumi
import pulumi_oci as oci
test_tables = oci.Nosql.get_tables(compartment_id=compartment_id,
name=table_name,
state=table_state)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/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: compartmentId,
Name: pulumi.StringRef(tableName),
State: pulumi.StringRef(tableState),
}, nil)
if err != nil {
return err
}
return nil
})
}
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 = compartmentId,
Name = tableName,
State = tableState,
});
});
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(compartmentId)
.name(tableName)
.state(tableState)
.build());
}
}
variables:
testTables:
fn::invoke:
function: oci:Nosql:getTables
arguments:
compartmentId: ${compartmentId}
name: ${tableName}
state: ${tableState}
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[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[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)
public static Output<GetTablesResult> getTables(GetTablesArgs args, InvokeOptions options)
fn::invoke:
function: oci:Nosql/getTables:getTables
arguments:
# arguments dictionaryThe following arguments are supported:
- Compartment
Id string - The ID of a table's compartment.
- Filters
List<Get
Tables Filter> - Name string
- A shell-globbing-style (*?[]) filter for names.
- State string
- Filter list by the lifecycle state of the item.
- Compartment
Id string - The ID of a table's compartment.
- Filters
[]Get
Tables Filter - Name string
- A shell-globbing-style (*?[]) filter for names.
- State string
- Filter list by the lifecycle state of the item.
- compartment
Id String - The ID of a table's compartment.
- filters
List<Get
Tables Filter> - name String
- A shell-globbing-style (*?[]) filter for names.
- state String
- Filter list by the lifecycle state of the item.
- compartment
Id string - The ID of a table's compartment.
- filters
Get
Tables Filter[] - 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
Sequence[Get
Tables Filter] - name str
- A shell-globbing-style (*?[]) filter for names.
- state str
- Filter list by the lifecycle state of the item.
- compartment
Id 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:
- Compartment
Id string - Compartment Identifier.
- Id string
- The provider-assigned unique ID for this managed resource.
- Table
Collections List<GetTables Table Collection> - The list of table_collection.
- Filters
List<Get
Tables Filter> - Name string
- Human-friendly table name, immutable.
- State string
- The state of a table.
- Compartment
Id string - Compartment Identifier.
- Id string
- The provider-assigned unique ID for this managed resource.
- Table
Collections []GetTables Table Collection - The list of table_collection.
- Filters
[]Get
Tables Filter - Name string
- Human-friendly table name, immutable.
- State string
- The state of a table.
- compartment
Id String - Compartment Identifier.
- id String
- The provider-assigned unique ID for this managed resource.
- table
Collections List<GetTables Table Collection> - The list of table_collection.
- filters
List<Get
Tables Filter> - name String
- Human-friendly table name, immutable.
- state String
- The state of a table.
- compartment
Id string - Compartment Identifier.
- id string
- The provider-assigned unique ID for this managed resource.
- table
Collections GetTables Table Collection[] - The list of table_collection.
- filters
Get
Tables Filter[] - 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 Sequence[GetTables Table Collection] - The list of table_collection.
- filters
Sequence[Get
Tables Filter] - name str
- Human-friendly table name, immutable.
- state str
- The state of a table.
- compartment
Id String - Compartment Identifier.
- id String
- The provider-assigned unique ID for this managed resource.
- table
Collections 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
GetTablesTableCollection
- Compartment
Id string - The ID of a table's compartment.
- Ddl
Statement string - Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}} - Dictionary<string, string>
- 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.
- Is
Auto boolReclaimable - True if this table can be reclaimed after an idle period.
- Is
Multi boolRegion - True if this table is currently a member of a replication set.
- Lifecycle
Details string - A message describing the current state in more detail.
- Local
Replica intInitialization In Percent - Name string
- A shell-globbing-style (*?[]) filter for names.
- Replicas
List<Get
Tables Table Collection Replica> - Schema
State 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<Get
Tables Table Collection Schema> - State string
- Filter list by the lifecycle state of the item.
- 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"}} - Table
Limits List<GetTables Table Collection Table Limit> - Throughput and storage limits configuration of a table.
- Time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- Time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- Time
Updated string - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- Compartment
Id string - The ID of a table's compartment.
- Ddl
Statement string - map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}} - map[string]string
- 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.
- Is
Auto boolReclaimable - True if this table can be reclaimed after an idle period.
- Is
Multi boolRegion - True if this table is currently a member of a replication set.
- Lifecycle
Details string - A message describing the current state in more detail.
- Local
Replica intInitialization In Percent - Name string
- A shell-globbing-style (*?[]) filter for names.
- Replicas
[]Get
Tables Table Collection Replica - Schema
State 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
[]Get
Tables Table Collection Schema - State string
- Filter list by the lifecycle state of the item.
- 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"}} - Table
Limits []GetTables Table Collection Table Limit - Throughput and storage limits configuration of a table.
- Time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- Time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- Time
Updated string - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- compartment
Id String - The ID of a table's compartment.
- ddl
Statement String - Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}} - Map<String,String>
- 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.
- is
Auto BooleanReclaimable - True if this table can be reclaimed after an idle period.
- is
Multi BooleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details String - A message describing the current state in more detail.
- local
Replica IntegerInitialization In Percent - name String
- A shell-globbing-style (*?[]) filter for names.
- replicas
List<Get
Tables Table Collection Replica> - schema
State 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<Get
Tables Table Collection Schema> - state String
- Filter list by the lifecycle state of the item.
- 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"}} - table
Limits List<GetTables Table Collection Table Limit> - Throughput and storage limits configuration of a table.
- time
Created String - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of StringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated String - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
- compartment
Id string - The ID of a table's compartment.
- ddl
Statement string - {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}} - {[key: string]: string}
- 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.
- is
Auto booleanReclaimable - True if this table can be reclaimed after an idle period.
- is
Multi booleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details string - A message describing the current state in more detail.
- local
Replica numberInitialization In Percent - name string
- A shell-globbing-style (*?[]) filter for names.
- replicas
Get
Tables Table Collection Replica[] - schema
State 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
Get
Tables Table Collection Schema[] - state string
- Filter list by the lifecycle state of the item.
- {[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"}} - table
Limits GetTables Table Collection Table Limit[] - Throughput and storage limits configuration of a table.
- time
Created string - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of stringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated 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 - Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}} - Mapping[str, str]
- 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_ boolreclaimable - True if this table can be reclaimed after an idle period.
- is_
multi_ boolregion - 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_ intinitialization_ in_ percent - name str
- A shell-globbing-style (*?[]) filter for names.
- replicas
Sequence[Get
Tables Table Collection Replica] - 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[Get
Tables Table Collection Schema] - state str
- Filter list by the lifecycle state of the item.
- 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 Sequence[GetTables Table Collection Table Limit] - 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_ strexpiration - 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.
- compartment
Id String - The ID of a table's compartment.
- ddl
Statement String - Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}} - Map<String>
- 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.
- is
Auto BooleanReclaimable - True if this table can be reclaimed after an idle period.
- is
Multi BooleanRegion - True if this table is currently a member of a replication set.
- lifecycle
Details String - A message describing the current state in more detail.
- local
Replica NumberInitialization In Percent - name String
- A shell-globbing-style (*?[]) filter for names.
- replicas List<Property Map>
- schema
State 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>
- state String
- Filter list by the lifecycle state of the item.
- 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"}} - table
Limits List<Property Map> - Throughput and storage limits configuration of a table.
- time
Created String - The time the the table was created. An RFC3339 formatted datetime string.
- time
Of StringExpiration - If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- time
Updated String - The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
GetTablesTableCollectionReplica
- Capacity
Mode 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.
- Lifecycle
Details string - A message describing the current state in more detail.
- Max
Write intUnits - Maximum sustained write throughput limit for the table.
- Region string
- State string
- Filter list by the lifecycle state of the item.
- Table
Id string
- Capacity
Mode 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.
- Lifecycle
Details string - A message describing the current state in more detail.
- Max
Write intUnits - Maximum sustained write throughput limit for the table.
- Region string
- State string
- Filter list by the lifecycle state of the item.
- Table
Id string
- capacity
Mode 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.
- lifecycle
Details String - A message describing the current state in more detail.
- max
Write IntegerUnits - Maximum sustained write throughput limit for the table.
- region String
- state String
- Filter list by the lifecycle state of the item.
- table
Id String
- capacity
Mode 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.
- lifecycle
Details string - A message describing the current state in more detail.
- max
Write numberUnits - Maximum sustained write throughput limit for the table.
- region string
- state string
- Filter list by the lifecycle state of the item.
- table
Id string
- 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_ intunits - Maximum sustained write throughput limit for the table.
- region str
- state str
- Filter list by the lifecycle state of the item.
- table_
id str
- capacity
Mode 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.
- lifecycle
Details String - A message describing the current state in more detail.
- max
Write NumberUnits - Maximum sustained write throughput limit for the table.
- region String
- state String
- Filter list by the lifecycle state of the item.
- table
Id String
GetTablesTableCollectionSchema
- Columns
List<Get
Tables Table Collection Schema Column> - Identities
List<Get
Tables Table Collection Schema Identity> - Primary
Keys List<string> - List<string>
- Ttl int
- columns
List<Get
Tables Table Collection Schema Column> - identities
List<Get
Tables Table Collection Schema Identity> - primary
Keys List<String> - List<String>
- ttl Integer
- columns
Sequence[Get
Tables Table Collection Schema Column] - identities
Sequence[Get
Tables Table Collection Schema Identity] - primary_
keys Sequence[str] - Sequence[str]
- ttl int
- columns List<Property Map>
- identities List<Property Map>
- primary
Keys List<String> - List<String>
- ttl Number
GetTablesTableCollectionSchemaColumn
- Default
Value string - Is
As boolUuid - Is
Generated bool - Is
Nullable bool - Name string
- A shell-globbing-style (*?[]) filter for names.
- Type string
- Default
Value string - Is
As boolUuid - Is
Generated bool - Is
Nullable bool - Name string
- A shell-globbing-style (*?[]) filter for names.
- Type string
- default
Value String - is
As BooleanUuid - is
Generated Boolean - is
Nullable Boolean - name String
- A shell-globbing-style (*?[]) filter for names.
- type String
- default
Value string - is
As booleanUuid - is
Generated boolean - is
Nullable boolean - name string
- A shell-globbing-style (*?[]) filter for names.
- type string
- default_
value str - is_
as_ booluuid - is_
generated bool - is_
nullable bool - name str
- A shell-globbing-style (*?[]) filter for names.
- type str
- default
Value String - is
As BooleanUuid - is
Generated Boolean - is
Nullable Boolean - name String
- A shell-globbing-style (*?[]) filter for names.
- type String
GetTablesTableCollectionSchemaIdentity
- Column
Name string - Is
Always bool - Is
Null bool
- Column
Name string - Is
Always bool - Is
Null bool
- column
Name String - is
Always Boolean - is
Null Boolean
- column
Name string - is
Always boolean - is
Null boolean
- column_
name str - is_
always bool - is_
null bool
- column
Name String - is
Always Boolean - is
Null Boolean
GetTablesTableCollectionTableLimit
- Capacity
Mode 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.
- Max
Read intUnits - Maximum sustained read throughput limit for the table.
- Max
Storage intIn Gbs - Maximum size of storage used by the table.
- Max
Write intUnits - Maximum sustained write throughput limit for the table.
- Capacity
Mode 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.
- Max
Read intUnits - Maximum sustained read throughput limit for the table.
- Max
Storage intIn Gbs - Maximum size of storage used by the table.
- Max
Write intUnits - Maximum sustained write throughput limit for the table.
- capacity
Mode 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.
- max
Read IntegerUnits - Maximum sustained read throughput limit for the table.
- max
Storage IntegerIn Gbs - Maximum size of storage used by the table.
- max
Write IntegerUnits - Maximum sustained write throughput limit for the table.
- capacity
Mode 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.
- max
Read numberUnits - Maximum sustained read throughput limit for the table.
- max
Storage numberIn Gbs - Maximum size of storage used by the table.
- max
Write numberUnits - 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_ intunits - Maximum sustained read throughput limit for the table.
- max_
storage_ intin_ gbs - Maximum size of storage used by the table.
- max_
write_ intunits - Maximum sustained write throughput limit for the table.
- capacity
Mode 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.
- max
Read NumberUnits - Maximum sustained read throughput limit for the table.
- max
Storage NumberIn Gbs - Maximum size of storage used by the table.
- max
Write NumberUnits - 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
ociTerraform Provider.
