Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataCatalog
  5. getMetastores
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataCatalog.getMetastores

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Metastores in Oracle Cloud Infrastructure Data Catalog service.

    Returns a list of all metastores in the specified compartment.

    Example Usage

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

const testMetastores = oci.DataCatalog.getMetastores({
    compartmentId: compartmentId,
    displayName: metastoreDisplayName,
    state: metastoreState,
});

    import pulumi
import pulumi_oci as oci

test_metastores = oci.DataCatalog.get_metastores(compartment_id=compartment_id,
    display_name=metastore_display_name,
    state=metastore_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datacatalog.GetMetastores(ctx, &datacatalog.GetMetastoresArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(metastoreDisplayName),
			State:         pulumi.StringRef(metastoreState),
		}, 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 testMetastores = Oci.DataCatalog.GetMetastores.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = metastoreDisplayName,
        State = metastoreState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataCatalog.DataCatalogFunctions;
import com.pulumi.oci.DataCatalog.inputs.GetMetastoresArgs;
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 testMetastores = DataCatalogFunctions.getMetastores(GetMetastoresArgs.builder()
            .compartmentId(compartmentId)
            .displayName(metastoreDisplayName)
            .state(metastoreState)
            .build());

    }
}

    variables:
  testMetastores:
    fn::invoke:
      function: oci:DataCatalog:getMetastores
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${metastoreDisplayName}
        state: ${metastoreState}

    Using getMetastores

    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 getMetastores(args: GetMetastoresArgs, opts?: InvokeOptions): Promise<GetMetastoresResult>
function getMetastoresOutput(args: GetMetastoresOutputArgs, opts?: InvokeOptions): Output<GetMetastoresResult>
    def get_metastores(compartment_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   filters: Optional[Sequence[_datacatalog.GetMetastoresFilter]] = None,
                   state: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetMetastoresResult
def get_metastores_output(compartment_id: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datacatalog.GetMetastoresFilterArgs]]]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetMetastoresResult]
    func GetMetastores(ctx *Context, args *GetMetastoresArgs, opts ...InvokeOption) (*GetMetastoresResult, error)
func GetMetastoresOutput(ctx *Context, args *GetMetastoresOutputArgs, opts ...InvokeOption) GetMetastoresResultOutput

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

    public static class GetMetastores 
{
    public static Task<GetMetastoresResult> InvokeAsync(GetMetastoresArgs args, InvokeOptions? opts = null)
    public static Output<GetMetastoresResult> Invoke(GetMetastoresInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMetastoresResult> getMetastores(GetMetastoresArgs args, InvokeOptions options)
public static Output<GetMetastoresResult> getMetastores(GetMetastoresArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:DataCatalog/getMetastores:getMetastores
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment where you want to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    Filters List<GetMetastoresFilter>
    State string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    CompartmentId string
    The OCID of the compartment where you want to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    Filters []GetMetastoresFilter
    State string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    compartmentId String
    The OCID of the compartment where you want to list resources.
    displayName String
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    filters List<GetMetastoresFilter>
    state String
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    compartmentId string
    The OCID of the compartment where you want to list resources.
    displayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    filters GetMetastoresFilter[]
    state string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    compartment_id str
    The OCID of the compartment where you want to list resources.
    display_name str
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    filters Sequence[datacatalog.GetMetastoresFilter]
    state str
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    compartmentId String
    The OCID of the compartment where you want to list resources.
    displayName String
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    filters List<Property Map>
    state String
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

    getMetastores Result

    The following output properties are available:

    CompartmentId string
    OCID of the compartment which holds the metastore.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metastores List<GetMetastoresMetastore>
    The list of metastores.
    DisplayName string
    Mutable name of the metastore.
    Filters List<GetMetastoresFilter>
    State string
    The current state of the metastore.
    CompartmentId string
    OCID of the compartment which holds the metastore.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metastores []GetMetastoresMetastore
    The list of metastores.
    DisplayName string
    Mutable name of the metastore.
    Filters []GetMetastoresFilter
    State string
    The current state of the metastore.
    compartmentId String
    OCID of the compartment which holds the metastore.
    id String
    The provider-assigned unique ID for this managed resource.
    metastores List<GetMetastoresMetastore>
    The list of metastores.
    displayName String
    Mutable name of the metastore.
    filters List<GetMetastoresFilter>
    state String
    The current state of the metastore.
    compartmentId string
    OCID of the compartment which holds the metastore.
    id string
    The provider-assigned unique ID for this managed resource.
    metastores GetMetastoresMetastore[]
    The list of metastores.
    displayName string
    Mutable name of the metastore.
    filters GetMetastoresFilter[]
    state string
    The current state of the metastore.
    compartment_id str
    OCID of the compartment which holds the metastore.
    id str
    The provider-assigned unique ID for this managed resource.
    metastores Sequence[datacatalog.GetMetastoresMetastore]
    The list of metastores.
    display_name str
    Mutable name of the metastore.
    filters Sequence[datacatalog.GetMetastoresFilter]
    state str
    The current state of the metastore.
    compartmentId String
    OCID of the compartment which holds the metastore.
    id String
    The provider-assigned unique ID for this managed resource.
    metastores List<Property Map>
    The list of metastores.
    displayName String
    Mutable name of the metastore.
    filters List<Property Map>
    state String
    The current state of the metastore.

    Supporting Types

    GetMetastoresFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetMetastoresMetastore

    CompartmentId string
    The OCID of the compartment where you want to list resources.
    DefaultExternalTableLocation string
    Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    DefaultManagedTableLocation string
    Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    DefinedTags Dictionary<string, string>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    FreeformTags 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
    The metastore's OCID.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    Locks List<GetMetastoresMetastoreLock>
    Locks associated with this resource.
    State string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    Time at which the metastore was last modified. An RFC3339 formatted datetime string.
    CompartmentId string
    The OCID of the compartment where you want to list resources.
    DefaultExternalTableLocation string
    Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    DefaultManagedTableLocation string
    Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    DefinedTags map[string]string
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    FreeformTags 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
    The metastore's OCID.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    Locks []GetMetastoresMetastoreLock
    Locks associated with this resource.
    State string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    Time at which the metastore was last modified. An RFC3339 formatted datetime string.
    compartmentId String
    The OCID of the compartment where you want to list resources.
    defaultExternalTableLocation String
    Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    defaultManagedTableLocation String
    Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    definedTags Map<String,String>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    freeformTags 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
    The metastore's OCID.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    locks List<GetMetastoresMetastoreLock>
    Locks associated with this resource.
    state String
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    timeUpdated String
    Time at which the metastore was last modified. An RFC3339 formatted datetime string.
    compartmentId string
    The OCID of the compartment where you want to list resources.
    defaultExternalTableLocation string
    Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    defaultManagedTableLocation string
    Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    definedTags {[key: string]: string}
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    freeformTags {[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
    The metastore's OCID.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    locks GetMetastoresMetastoreLock[]
    Locks associated with this resource.
    state string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    timeUpdated string
    Time at which the metastore was last modified. An RFC3339 formatted datetime string.
    compartment_id str
    The OCID of the compartment where you want to list resources.
    default_external_table_location str
    Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    default_managed_table_location str
    Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    defined_tags Mapping[str, str]
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    freeform_tags 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
    The metastore's OCID.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    locks Sequence[datacatalog.GetMetastoresMetastoreLock]
    Locks associated with this resource.
    state str
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    time_updated str
    Time at which the metastore was last modified. An RFC3339 formatted datetime string.
    compartmentId String
    The OCID of the compartment where you want to list resources.
    defaultExternalTableLocation String
    Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    defaultManagedTableLocation String
    Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
    definedTags Map<String>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    freeformTags 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
    The metastore's OCID.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    locks List<Property Map>
    Locks associated with this resource.
    state String
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    timeUpdated String
    Time at which the metastore was last modified. An RFC3339 formatted datetime string.

    GetMetastoresMetastoreLock

    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    Type string
    Type of the lock.
    Message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    RelatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    TimeCreated string
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    Type string
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    type String
    Type of the lock.
    message string
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId string
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated string
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    type string
    Type of the lock.
    message str
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    related_resource_id str
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    time_created str
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    type str
    Type of the lock.
    message String
    A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
    relatedResourceId String
    The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
    timeCreated String
    Time at which the metastore was created. An RFC3339 formatted datetime string.
    type String
    Type of the lock.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci