1. Packages
  2. InfluxDB V3
  3. API Docs
  4. getDatabase
Viewing docs for InfluxDB3 v1.3.0
published on Tuesday, Mar 11, 2025 by DEPRECATED
Schema (JSON)
thulasirajkomminar/pulumi-influxdb3

influxdb3.getDatabase

influxdb3 logo
Viewing docs for InfluxDB3 v1.3.0
published on Tuesday, Mar 11, 2025 by DEPRECATED
Schema (JSON)
thulasirajkomminar/pulumi-influxdb3

    Retrieves a database. Use this data source to retrieve information for a specific database.

    Using getDatabase

    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 getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>
    def get_database(name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]
    func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

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

    public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)

    fn::invoke:
  function: influxdb3:index/getDatabase:getDatabase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the cluster database.
    Name string
    The name of the cluster database.
    name String
    The name of the cluster database.
    name string
    The name of the cluster database.
    name str
    The name of the cluster database.
    name String
    The name of the cluster database.

    getDatabase Result

    The following output properties are available:

    AccountId string
    The ID of the account that the database belongs to.
    ClusterId string
    The ID of the cluster that the database belongs to.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxColumnsPerTable int
    The maximum number of columns per table for the cluster database.
    MaxTables int
    The maximum number of tables for the cluster database.
    Name string
    The name of the cluster database.
    PartitionTemplates List<KomminarLabs.InfluxDB3.Outputs.GetDatabasePartitionTemplate>
    The template partitioning of the cluster database.
    RetentionPeriod int
    The retention period of the cluster database in nanoseconds.
    AccountId string
    The ID of the account that the database belongs to.
    ClusterId string
    The ID of the cluster that the database belongs to.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxColumnsPerTable int
    The maximum number of columns per table for the cluster database.
    MaxTables int
    The maximum number of tables for the cluster database.
    Name string
    The name of the cluster database.
    PartitionTemplates []GetDatabasePartitionTemplate
    The template partitioning of the cluster database.
    RetentionPeriod int
    The retention period of the cluster database in nanoseconds.
    accountId String
    The ID of the account that the database belongs to.
    clusterId String
    The ID of the cluster that the database belongs to.
    id String
    The provider-assigned unique ID for this managed resource.
    maxColumnsPerTable Integer
    The maximum number of columns per table for the cluster database.
    maxTables Integer
    The maximum number of tables for the cluster database.
    name String
    The name of the cluster database.
    partitionTemplates List<GetDatabasePartitionTemplate>
    The template partitioning of the cluster database.
    retentionPeriod Integer
    The retention period of the cluster database in nanoseconds.
    accountId string
    The ID of the account that the database belongs to.
    clusterId string
    The ID of the cluster that the database belongs to.
    id string
    The provider-assigned unique ID for this managed resource.
    maxColumnsPerTable number
    The maximum number of columns per table for the cluster database.
    maxTables number
    The maximum number of tables for the cluster database.
    name string
    The name of the cluster database.
    partitionTemplates GetDatabasePartitionTemplate[]
    The template partitioning of the cluster database.
    retentionPeriod number
    The retention period of the cluster database in nanoseconds.
    account_id str
    The ID of the account that the database belongs to.
    cluster_id str
    The ID of the cluster that the database belongs to.
    id str
    The provider-assigned unique ID for this managed resource.
    max_columns_per_table int
    The maximum number of columns per table for the cluster database.
    max_tables int
    The maximum number of tables for the cluster database.
    name str
    The name of the cluster database.
    partition_templates Sequence[GetDatabasePartitionTemplate]
    The template partitioning of the cluster database.
    retention_period int
    The retention period of the cluster database in nanoseconds.
    accountId String
    The ID of the account that the database belongs to.
    clusterId String
    The ID of the cluster that the database belongs to.
    id String
    The provider-assigned unique ID for this managed resource.
    maxColumnsPerTable Number
    The maximum number of columns per table for the cluster database.
    maxTables Number
    The maximum number of tables for the cluster database.
    name String
    The name of the cluster database.
    partitionTemplates List<Property Map>
    The template partitioning of the cluster database.
    retentionPeriod Number
    The retention period of the cluster database in nanoseconds.

    Supporting Types

    GetDatabasePartitionTemplate

    Type string
    The type of template part.
    Value string
    The value of template part.
    Type string
    The type of template part.
    Value string
    The value of template part.
    type String
    The type of template part.
    value String
    The value of template part.
    type string
    The type of template part.
    value string
    The value of template part.
    type str
    The type of template part.
    value str
    The value of template part.
    type String
    The type of template part.
    value String
    The value of template part.

    Package Details

    Repository
    influxdb3 komminarlabs/pulumi-influxdb3
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the influxdb3 Terraform Provider.
    influxdb3 logo
    Viewing docs for InfluxDB3 v1.3.0
    published on Tuesday, Mar 11, 2025 by DEPRECATED
    Schema (JSON)
    thulasirajkomminar/pulumi-influxdb3
      Try Pulumi Cloud free. Your team will thank you.