1. Packages
  2. Packages
  3. DigitalOcean Provider
  4. API Docs
  5. getVectorDatabase
Viewing docs for DigitalOcean v4.73.0
published on Friday, Jul 3, 2026 by Pulumi
digitalocean logo
Viewing docs for DigitalOcean v4.73.0
published on Friday, Jul 3, 2026 by Pulumi

    Provides information on a DigitalOcean vector database resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const example = digitalocean.getVectorDatabase({
        name: "example-vector-db",
    });
    export const vectorDbHttpEndpoint = example.then(example => example.endpoints?.[0]?.http);
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    example = digitalocean.get_vector_database(name="example-vector-db")
    pulumi.export("vectorDbHttpEndpoint", example.endpoints[0].http)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := digitalocean.GetVectorDatabase(ctx, &digitalocean.LookupVectorDatabaseArgs{
    			Name: pulumi.StringRef("example-vector-db"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("vectorDbHttpEndpoint", example.Endpoints[0].Http)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var example = DigitalOcean.GetVectorDatabase.Invoke(new()
        {
            Name = "example-vector-db",
        });
    
        return new Dictionary<string, object?>
        {
            ["vectorDbHttpEndpoint"] = example.Apply(getVectorDatabaseResult => getVectorDatabaseResult.Endpoints[0]?.Http),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.DigitaloceanFunctions;
    import com.pulumi.digitalocean.inputs.GetVectorDatabaseArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = DigitaloceanFunctions.getVectorDatabase(GetVectorDatabaseArgs.builder()
                .name("example-vector-db")
                .build());
    
            ctx.export("vectorDbHttpEndpoint", example.endpoints()[0].http());
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: digitalocean:getVectorDatabase
          arguments:
            name: example-vector-db
    outputs:
      vectorDbHttpEndpoint: ${example.endpoints[0].http}
    
    pulumi {
      required_providers {
        digitalocean = {
          source = "pulumi/digitalocean"
        }
      }
    }
    
    data "digitalocean_getvectordatabase" "example" {
      name = "example-vector-db"
    }
    
    output "vectorDbHttpEndpoint" {
      value = data.digitalocean_getvectordatabase.example.endpoints[0].http
    }
    

    A vector database may also be looked up by its id:

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const example = digitalocean.getVectorDatabase({
        id: "245bcfd0-7f31-4ce6-a2bc-475a116cca97",
    });
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    example = digitalocean.get_vector_database(id="245bcfd0-7f31-4ce6-a2bc-475a116cca97")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := digitalocean.GetVectorDatabase(ctx, &digitalocean.LookupVectorDatabaseArgs{
    			Id: pulumi.StringRef("245bcfd0-7f31-4ce6-a2bc-475a116cca97"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var example = DigitalOcean.GetVectorDatabase.Invoke(new()
        {
            Id = "245bcfd0-7f31-4ce6-a2bc-475a116cca97",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.DigitaloceanFunctions;
    import com.pulumi.digitalocean.inputs.GetVectorDatabaseArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = DigitaloceanFunctions.getVectorDatabase(GetVectorDatabaseArgs.builder()
                .id("245bcfd0-7f31-4ce6-a2bc-475a116cca97")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: digitalocean:getVectorDatabase
          arguments:
            id: 245bcfd0-7f31-4ce6-a2bc-475a116cca97
    
    pulumi {
      required_providers {
        digitalocean = {
          source = "pulumi/digitalocean"
        }
      }
    }
    
    data "digitalocean_getvectordatabase" "example" {
      id = "245bcfd0-7f31-4ce6-a2bc-475a116cca97"
    }
    

    Using getVectorDatabase

    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 getVectorDatabase(args: GetVectorDatabaseArgs, opts?: InvokeOptions): Promise<GetVectorDatabaseResult>
    function getVectorDatabaseOutput(args: GetVectorDatabaseOutputArgs, opts?: InvokeOptions): Output<GetVectorDatabaseResult>
    def get_vector_database(id: Optional[str] = None,
                            name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetVectorDatabaseResult
    def get_vector_database_output(id: pulumi.Input[Optional[str]] = None,
                            name: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetVectorDatabaseResult]
    func LookupVectorDatabase(ctx *Context, args *LookupVectorDatabaseArgs, opts ...InvokeOption) (*LookupVectorDatabaseResult, error)
    func LookupVectorDatabaseOutput(ctx *Context, args *LookupVectorDatabaseOutputArgs, opts ...InvokeOption) LookupVectorDatabaseResultOutput

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

    public static class GetVectorDatabase 
    {
        public static Task<GetVectorDatabaseResult> InvokeAsync(GetVectorDatabaseArgs args, InvokeOptions? opts = null)
        public static Output<GetVectorDatabaseResult> Invoke(GetVectorDatabaseInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVectorDatabaseResult> getVectorDatabase(GetVectorDatabaseArgs args, InvokeOptions options)
    public static Output<GetVectorDatabaseResult> getVectorDatabase(GetVectorDatabaseArgs args, InvokeOptions options)
    
    fn::invoke:
      function: digitalocean:index/getVectorDatabase:getVectorDatabase
      arguments:
        # arguments dictionary
    data "digitalocean_getvectordatabase" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    The ID of the vector database.
    Name string
    The name of the vector database.
    Id string
    The ID of the vector database.
    Name string
    The name of the vector database.
    id string
    The ID of the vector database.
    name string
    The name of the vector database.
    id String
    The ID of the vector database.
    name String
    The name of the vector database.
    id string
    The ID of the vector database.
    name string
    The name of the vector database.
    id str
    The ID of the vector database.
    name str
    The name of the vector database.
    id String
    The ID of the vector database.
    name String
    The name of the vector database.

    getVectorDatabase Result

    The following output properties are available:

    Configs List<Pulumi.DigitalOcean.Outputs.GetVectorDatabaseConfig>
    Advanced configuration for the vector database. The structure is documented below.
    CreatedAt string
    The date and time when the vector database was created.
    Endpoints List<Pulumi.DigitalOcean.Outputs.GetVectorDatabaseEndpoint>
    The connection endpoints for the vector database. The structure is documented below.
    Id string
    The ID of the vector database.
    Name string
    The name of the vector database.
    OwnerUuid string
    The UUID of the account that owns the vector database.
    Region string
    The slug identifier for the region where the vector database is located.
    Size string
    The slug identifier representing the size of the vector database.
    Status string
    The current status of the vector database (ex. active).
    Tags List<string>
    A list of tag names applied to the vector database.
    UpdatedAt string
    The date and time when the vector database was last updated.
    Configs []GetVectorDatabaseConfig
    Advanced configuration for the vector database. The structure is documented below.
    CreatedAt string
    The date and time when the vector database was created.
    Endpoints []GetVectorDatabaseEndpoint
    The connection endpoints for the vector database. The structure is documented below.
    Id string
    The ID of the vector database.
    Name string
    The name of the vector database.
    OwnerUuid string
    The UUID of the account that owns the vector database.
    Region string
    The slug identifier for the region where the vector database is located.
    Size string
    The slug identifier representing the size of the vector database.
    Status string
    The current status of the vector database (ex. active).
    Tags []string
    A list of tag names applied to the vector database.
    UpdatedAt string
    The date and time when the vector database was last updated.
    configs list(object)
    Advanced configuration for the vector database. The structure is documented below.
    created_at string
    The date and time when the vector database was created.
    endpoints list(object)
    The connection endpoints for the vector database. The structure is documented below.
    id string
    The ID of the vector database.
    name string
    The name of the vector database.
    owner_uuid string
    The UUID of the account that owns the vector database.
    region string
    The slug identifier for the region where the vector database is located.
    size string
    The slug identifier representing the size of the vector database.
    status string
    The current status of the vector database (ex. active).
    tags list(string)
    A list of tag names applied to the vector database.
    updated_at string
    The date and time when the vector database was last updated.
    configs List<GetVectorDatabaseConfig>
    Advanced configuration for the vector database. The structure is documented below.
    createdAt String
    The date and time when the vector database was created.
    endpoints List<GetVectorDatabaseEndpoint>
    The connection endpoints for the vector database. The structure is documented below.
    id String
    The ID of the vector database.
    name String
    The name of the vector database.
    ownerUuid String
    The UUID of the account that owns the vector database.
    region String
    The slug identifier for the region where the vector database is located.
    size String
    The slug identifier representing the size of the vector database.
    status String
    The current status of the vector database (ex. active).
    tags List<String>
    A list of tag names applied to the vector database.
    updatedAt String
    The date and time when the vector database was last updated.
    configs GetVectorDatabaseConfig[]
    Advanced configuration for the vector database. The structure is documented below.
    createdAt string
    The date and time when the vector database was created.
    endpoints GetVectorDatabaseEndpoint[]
    The connection endpoints for the vector database. The structure is documented below.
    id string
    The ID of the vector database.
    name string
    The name of the vector database.
    ownerUuid string
    The UUID of the account that owns the vector database.
    region string
    The slug identifier for the region where the vector database is located.
    size string
    The slug identifier representing the size of the vector database.
    status string
    The current status of the vector database (ex. active).
    tags string[]
    A list of tag names applied to the vector database.
    updatedAt string
    The date and time when the vector database was last updated.
    configs Sequence[GetVectorDatabaseConfig]
    Advanced configuration for the vector database. The structure is documented below.
    created_at str
    The date and time when the vector database was created.
    endpoints Sequence[GetVectorDatabaseEndpoint]
    The connection endpoints for the vector database. The structure is documented below.
    id str
    The ID of the vector database.
    name str
    The name of the vector database.
    owner_uuid str
    The UUID of the account that owns the vector database.
    region str
    The slug identifier for the region where the vector database is located.
    size str
    The slug identifier representing the size of the vector database.
    status str
    The current status of the vector database (ex. active).
    tags Sequence[str]
    A list of tag names applied to the vector database.
    updated_at str
    The date and time when the vector database was last updated.
    configs List<Property Map>
    Advanced configuration for the vector database. The structure is documented below.
    createdAt String
    The date and time when the vector database was created.
    endpoints List<Property Map>
    The connection endpoints for the vector database. The structure is documented below.
    id String
    The ID of the vector database.
    name String
    The name of the vector database.
    ownerUuid String
    The UUID of the account that owns the vector database.
    region String
    The slug identifier for the region where the vector database is located.
    size String
    The slug identifier representing the size of the vector database.
    status String
    The current status of the vector database (ex. active).
    tags List<String>
    A list of tag names applied to the vector database.
    updatedAt String
    The date and time when the vector database was last updated.

    Supporting Types

    GetVectorDatabaseConfig

    DefaultQuantization string
    The default vector quantization method applied to new collections.
    EnableAutoSchema bool
    Whether Weaviate's auto-schema feature is enabled.
    WeaviateVersion string
    The Weaviate engine version used by the vector database.
    DefaultQuantization string
    The default vector quantization method applied to new collections.
    EnableAutoSchema bool
    Whether Weaviate's auto-schema feature is enabled.
    WeaviateVersion string
    The Weaviate engine version used by the vector database.
    default_quantization string
    The default vector quantization method applied to new collections.
    enable_auto_schema bool
    Whether Weaviate's auto-schema feature is enabled.
    weaviate_version string
    The Weaviate engine version used by the vector database.
    defaultQuantization String
    The default vector quantization method applied to new collections.
    enableAutoSchema Boolean
    Whether Weaviate's auto-schema feature is enabled.
    weaviateVersion String
    The Weaviate engine version used by the vector database.
    defaultQuantization string
    The default vector quantization method applied to new collections.
    enableAutoSchema boolean
    Whether Weaviate's auto-schema feature is enabled.
    weaviateVersion string
    The Weaviate engine version used by the vector database.
    default_quantization str
    The default vector quantization method applied to new collections.
    enable_auto_schema bool
    Whether Weaviate's auto-schema feature is enabled.
    weaviate_version str
    The Weaviate engine version used by the vector database.
    defaultQuantization String
    The default vector quantization method applied to new collections.
    enableAutoSchema Boolean
    Whether Weaviate's auto-schema feature is enabled.
    weaviateVersion String
    The Weaviate engine version used by the vector database.

    GetVectorDatabaseEndpoint

    Grpc string
    The gRPC endpoint used to connect to the vector database.
    Http string
    The HTTP endpoint used to connect to the vector database.
    Grpc string
    The gRPC endpoint used to connect to the vector database.
    Http string
    The HTTP endpoint used to connect to the vector database.
    grpc string
    The gRPC endpoint used to connect to the vector database.
    http string
    The HTTP endpoint used to connect to the vector database.
    grpc String
    The gRPC endpoint used to connect to the vector database.
    http String
    The HTTP endpoint used to connect to the vector database.
    grpc string
    The gRPC endpoint used to connect to the vector database.
    http string
    The HTTP endpoint used to connect to the vector database.
    grpc str
    The gRPC endpoint used to connect to the vector database.
    http str
    The HTTP endpoint used to connect to the vector database.
    grpc String
    The gRPC endpoint used to connect to the vector database.
    http String
    The HTTP endpoint used to connect to the vector database.

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    Viewing docs for DigitalOcean v4.73.0
    published on Friday, Jul 3, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial