DbSchema

Harness v0.9.3, Nov 25 25

Harness v0.9.3 published on Tuesday, Nov 25, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-harness

Harness v0.9.3 published on Tuesday, Nov 25, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-harness

Example Usage

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

const defaultTypeTest = new harness.platform.DbSchema("default_type_test", {
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
    name: "name",
    service: "service1",
    tags: [
        "foo:bar",
        "bar:foo",
    ],
    schemaSource: {
        connector: "gitConnector",
        repo: "TestRepo",
        location: "db/example-changelog.yaml",
        archivePath: "path/to/archive.zip",
    },
});
const liquibaseRepositoryTest = new harness.platform.DbSchema("liquibase_repository_test", {
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
    name: "name",
    service: "service1",
    type: "Repository",
    migrationType: "Liquibase",
    tags: [
        "foo:bar",
        "bar:foo",
    ],
    schemaSource: {
        connector: "gitConnector",
        repo: "TestRepo",
        location: "db/example-changelog.yaml",
        archivePath: "path/to/archive.zip",
    },
});
const liquibaseScriptTest = new harness.platform.DbSchema("liquibase_script_test", {
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
    name: "name",
    migrationType: "Liquibase",
    service: "service1",
    type: "Script",
    tags: [
        "foo:bar",
        "bar:foo",
    ],
    changelogScript: {
        image: "plugins/image",
        command: "echo \\\"hello dbops\\\"",
        shell: "sh/bash",
        location: "db/example-changelog.yaml",
    },
});
const flywayRepositoryTest = new harness.platform.DbSchema("flyway_repository_test", {
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
    name: "name",
    service: "service1",
    type: "Repository",
    migrationType: "Flyway",
    tags: [
        "foo:bar",
        "bar:foo",
    ],
    schemaSource: {
        connector: "gitConnector",
        repo: "TestRepo",
        location: "db/flyway/migrations",
        toml: "db/flyway.toml",
        archivePath: "path/to/archive.zip",
    },
});
const flywayScriptTest = new harness.platform.DbSchema("flyway_script_test", {
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
    name: "name",
    migrationType: "Flyway",
    service: "service1",
    type: "Script",
    tags: [
        "foo:bar",
        "bar:foo",
    ],
    changelogScript: {
        image: "plugins/image",
        command: "echo \\\"hello dbops\\\"",
        shell: "sh/bash",
        location: "db/flyway/migrations",
        toml: "db/flyway.toml",
    },
});

import pulumi
import pulumi_harness as harness

default_type_test = harness.platform.DbSchema("default_type_test",
    identifier="identifier",
    org_id="org_id",
    project_id="project_id",
    name="name",
    service="service1",
    tags=[
        "foo:bar",
        "bar:foo",
    ],
    schema_source={
        "connector": "gitConnector",
        "repo": "TestRepo",
        "location": "db/example-changelog.yaml",
        "archive_path": "path/to/archive.zip",
    })
liquibase_repository_test = harness.platform.DbSchema("liquibase_repository_test",
    identifier="identifier",
    org_id="org_id",
    project_id="project_id",
    name="name",
    service="service1",
    type="Repository",
    migration_type="Liquibase",
    tags=[
        "foo:bar",
        "bar:foo",
    ],
    schema_source={
        "connector": "gitConnector",
        "repo": "TestRepo",
        "location": "db/example-changelog.yaml",
        "archive_path": "path/to/archive.zip",
    })
liquibase_script_test = harness.platform.DbSchema("liquibase_script_test",
    identifier="identifier",
    org_id="org_id",
    project_id="project_id",
    name="name",
    migration_type="Liquibase",
    service="service1",
    type="Script",
    tags=[
        "foo:bar",
        "bar:foo",
    ],
    changelog_script={
        "image": "plugins/image",
        "command": "echo \\\"hello dbops\\\"",
        "shell": "sh/bash",
        "location": "db/example-changelog.yaml",
    })
flyway_repository_test = harness.platform.DbSchema("flyway_repository_test",
    identifier="identifier",
    org_id="org_id",
    project_id="project_id",
    name="name",
    service="service1",
    type="Repository",
    migration_type="Flyway",
    tags=[
        "foo:bar",
        "bar:foo",
    ],
    schema_source={
        "connector": "gitConnector",
        "repo": "TestRepo",
        "location": "db/flyway/migrations",
        "toml": "db/flyway.toml",
        "archive_path": "path/to/archive.zip",
    })
flyway_script_test = harness.platform.DbSchema("flyway_script_test",
    identifier="identifier",
    org_id="org_id",
    project_id="project_id",
    name="name",
    migration_type="Flyway",
    service="service1",
    type="Script",
    tags=[
        "foo:bar",
        "bar:foo",
    ],
    changelog_script={
        "image": "plugins/image",
        "command": "echo \\\"hello dbops\\\"",
        "shell": "sh/bash",
        "location": "db/flyway/migrations",
        "toml": "db/flyway.toml",
    })

package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.NewDbSchema(ctx, "default_type_test", &platform.DbSchemaArgs{
			Identifier: pulumi.String("identifier"),
			OrgId:      pulumi.String("org_id"),
			ProjectId:  pulumi.String("project_id"),
			Name:       pulumi.String("name"),
			Service:    pulumi.String("service1"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("bar:foo"),
			},
			SchemaSource: &platform.DbSchemaSchemaSourceArgs{
				Connector:   pulumi.String("gitConnector"),
				Repo:        pulumi.String("TestRepo"),
				Location:    pulumi.String("db/example-changelog.yaml"),
				ArchivePath: pulumi.String("path/to/archive.zip"),
			},
		})
		if err != nil {
			return err
		}
		_, err = platform.NewDbSchema(ctx, "liquibase_repository_test", &platform.DbSchemaArgs{
			Identifier:    pulumi.String("identifier"),
			OrgId:         pulumi.String("org_id"),
			ProjectId:     pulumi.String("project_id"),
			Name:          pulumi.String("name"),
			Service:       pulumi.String("service1"),
			Type:          pulumi.String("Repository"),
			MigrationType: pulumi.String("Liquibase"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("bar:foo"),
			},
			SchemaSource: &platform.DbSchemaSchemaSourceArgs{
				Connector:   pulumi.String("gitConnector"),
				Repo:        pulumi.String("TestRepo"),
				Location:    pulumi.String("db/example-changelog.yaml"),
				ArchivePath: pulumi.String("path/to/archive.zip"),
			},
		})
		if err != nil {
			return err
		}
		_, err = platform.NewDbSchema(ctx, "liquibase_script_test", &platform.DbSchemaArgs{
			Identifier:    pulumi.String("identifier"),
			OrgId:         pulumi.String("org_id"),
			ProjectId:     pulumi.String("project_id"),
			Name:          pulumi.String("name"),
			MigrationType: pulumi.String("Liquibase"),
			Service:       pulumi.String("service1"),
			Type:          pulumi.String("Script"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("bar:foo"),
			},
			ChangelogScript: &platform.DbSchemaChangelogScriptArgs{
				Image:    pulumi.String("plugins/image"),
				Command:  pulumi.String("echo \\\"hello dbops\\\""),
				Shell:    pulumi.String("sh/bash"),
				Location: pulumi.String("db/example-changelog.yaml"),
			},
		})
		if err != nil {
			return err
		}
		_, err = platform.NewDbSchema(ctx, "flyway_repository_test", &platform.DbSchemaArgs{
			Identifier:    pulumi.String("identifier"),
			OrgId:         pulumi.String("org_id"),
			ProjectId:     pulumi.String("project_id"),
			Name:          pulumi.String("name"),
			Service:       pulumi.String("service1"),
			Type:          pulumi.String("Repository"),
			MigrationType: pulumi.String("Flyway"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("bar:foo"),
			},
			SchemaSource: &platform.DbSchemaSchemaSourceArgs{
				Connector:   pulumi.String("gitConnector"),
				Repo:        pulumi.String("TestRepo"),
				Location:    pulumi.String("db/flyway/migrations"),
				Toml:        pulumi.String("db/flyway.toml"),
				ArchivePath: pulumi.String("path/to/archive.zip"),
			},
		})
		if err != nil {
			return err
		}
		_, err = platform.NewDbSchema(ctx, "flyway_script_test", &platform.DbSchemaArgs{
			Identifier:    pulumi.String("identifier"),
			OrgId:         pulumi.String("org_id"),
			ProjectId:     pulumi.String("project_id"),
			Name:          pulumi.String("name"),
			MigrationType: pulumi.String("Flyway"),
			Service:       pulumi.String("service1"),
			Type:          pulumi.String("Script"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("bar:foo"),
			},
			ChangelogScript: &platform.DbSchemaChangelogScriptArgs{
				Image:    pulumi.String("plugins/image"),
				Command:  pulumi.String("echo \\\"hello dbops\\\""),
				Shell:    pulumi.String("sh/bash"),
				Location: pulumi.String("db/flyway/migrations"),
				Toml:     pulumi.String("db/flyway.toml"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;

return await Deployment.RunAsync(() => 
{
    var defaultTypeTest = new Harness.Platform.DbSchema("default_type_test", new()
    {
        Identifier = "identifier",
        OrgId = "org_id",
        ProjectId = "project_id",
        Name = "name",
        Service = "service1",
        Tags = new[]
        {
            "foo:bar",
            "bar:foo",
        },
        SchemaSource = new Harness.Platform.Inputs.DbSchemaSchemaSourceArgs
        {
            Connector = "gitConnector",
            Repo = "TestRepo",
            Location = "db/example-changelog.yaml",
            ArchivePath = "path/to/archive.zip",
        },
    });

    var liquibaseRepositoryTest = new Harness.Platform.DbSchema("liquibase_repository_test", new()
    {
        Identifier = "identifier",
        OrgId = "org_id",
        ProjectId = "project_id",
        Name = "name",
        Service = "service1",
        Type = "Repository",
        MigrationType = "Liquibase",
        Tags = new[]
        {
            "foo:bar",
            "bar:foo",
        },
        SchemaSource = new Harness.Platform.Inputs.DbSchemaSchemaSourceArgs
        {
            Connector = "gitConnector",
            Repo = "TestRepo",
            Location = "db/example-changelog.yaml",
            ArchivePath = "path/to/archive.zip",
        },
    });

    var liquibaseScriptTest = new Harness.Platform.DbSchema("liquibase_script_test", new()
    {
        Identifier = "identifier",
        OrgId = "org_id",
        ProjectId = "project_id",
        Name = "name",
        MigrationType = "Liquibase",
        Service = "service1",
        Type = "Script",
        Tags = new[]
        {
            "foo:bar",
            "bar:foo",
        },
        ChangelogScript = new Harness.Platform.Inputs.DbSchemaChangelogScriptArgs
        {
            Image = "plugins/image",
            Command = "echo \\\"hello dbops\\\"",
            Shell = "sh/bash",
            Location = "db/example-changelog.yaml",
        },
    });

    var flywayRepositoryTest = new Harness.Platform.DbSchema("flyway_repository_test", new()
    {
        Identifier = "identifier",
        OrgId = "org_id",
        ProjectId = "project_id",
        Name = "name",
        Service = "service1",
        Type = "Repository",
        MigrationType = "Flyway",
        Tags = new[]
        {
            "foo:bar",
            "bar:foo",
        },
        SchemaSource = new Harness.Platform.Inputs.DbSchemaSchemaSourceArgs
        {
            Connector = "gitConnector",
            Repo = "TestRepo",
            Location = "db/flyway/migrations",
            Toml = "db/flyway.toml",
            ArchivePath = "path/to/archive.zip",
        },
    });

    var flywayScriptTest = new Harness.Platform.DbSchema("flyway_script_test", new()
    {
        Identifier = "identifier",
        OrgId = "org_id",
        ProjectId = "project_id",
        Name = "name",
        MigrationType = "Flyway",
        Service = "service1",
        Type = "Script",
        Tags = new[]
        {
            "foo:bar",
            "bar:foo",
        },
        ChangelogScript = new Harness.Platform.Inputs.DbSchemaChangelogScriptArgs
        {
            Image = "plugins/image",
            Command = "echo \\\"hello dbops\\\"",
            Shell = "sh/bash",
            Location = "db/flyway/migrations",
            Toml = "db/flyway.toml",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.DbSchema;
import com.pulumi.harness.platform.DbSchemaArgs;
import com.pulumi.harness.platform.inputs.DbSchemaSchemaSourceArgs;
import com.pulumi.harness.platform.inputs.DbSchemaChangelogScriptArgs;
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) {
        var defaultTypeTest = new DbSchema("defaultTypeTest", DbSchemaArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .name("name")
            .service("service1")
            .tags(            
                "foo:bar",
                "bar:foo")
            .schemaSource(DbSchemaSchemaSourceArgs.builder()
                .connector("gitConnector")
                .repo("TestRepo")
                .location("db/example-changelog.yaml")
                .archivePath("path/to/archive.zip")
                .build())
            .build());

        var liquibaseRepositoryTest = new DbSchema("liquibaseRepositoryTest", DbSchemaArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .name("name")
            .service("service1")
            .type("Repository")
            .migrationType("Liquibase")
            .tags(            
                "foo:bar",
                "bar:foo")
            .schemaSource(DbSchemaSchemaSourceArgs.builder()
                .connector("gitConnector")
                .repo("TestRepo")
                .location("db/example-changelog.yaml")
                .archivePath("path/to/archive.zip")
                .build())
            .build());

        var liquibaseScriptTest = new DbSchema("liquibaseScriptTest", DbSchemaArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .name("name")
            .migrationType("Liquibase")
            .service("service1")
            .type("Script")
            .tags(            
                "foo:bar",
                "bar:foo")
            .changelogScript(DbSchemaChangelogScriptArgs.builder()
                .image("plugins/image")
                .command("echo \\\"hello dbops\\\"")
                .shell("sh/bash")
                .location("db/example-changelog.yaml")
                .build())
            .build());

        var flywayRepositoryTest = new DbSchema("flywayRepositoryTest", DbSchemaArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .name("name")
            .service("service1")
            .type("Repository")
            .migrationType("Flyway")
            .tags(            
                "foo:bar",
                "bar:foo")
            .schemaSource(DbSchemaSchemaSourceArgs.builder()
                .connector("gitConnector")
                .repo("TestRepo")
                .location("db/flyway/migrations")
                .toml("db/flyway.toml")
                .archivePath("path/to/archive.zip")
                .build())
            .build());

        var flywayScriptTest = new DbSchema("flywayScriptTest", DbSchemaArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .name("name")
            .migrationType("Flyway")
            .service("service1")
            .type("Script")
            .tags(            
                "foo:bar",
                "bar:foo")
            .changelogScript(DbSchemaChangelogScriptArgs.builder()
                .image("plugins/image")
                .command("echo \\\"hello dbops\\\"")
                .shell("sh/bash")
                .location("db/flyway/migrations")
                .toml("db/flyway.toml")
                .build())
            .build());

    }
}

resources:
  defaultTypeTest:
    type: harness:platform:DbSchema
    name: default_type_test
    properties:
      identifier: identifier
      orgId: org_id
      projectId: project_id
      name: name
      service: service1
      tags:
        - foo:bar
        - bar:foo
      schemaSource:
        connector: gitConnector
        repo: TestRepo
        location: db/example-changelog.yaml
        archivePath: path/to/archive.zip
  liquibaseRepositoryTest:
    type: harness:platform:DbSchema
    name: liquibase_repository_test
    properties:
      identifier: identifier
      orgId: org_id
      projectId: project_id
      name: name
      service: service1
      type: Repository
      migrationType: Liquibase
      tags:
        - foo:bar
        - bar:foo
      schemaSource:
        connector: gitConnector
        repo: TestRepo
        location: db/example-changelog.yaml
        archivePath: path/to/archive.zip
  liquibaseScriptTest:
    type: harness:platform:DbSchema
    name: liquibase_script_test
    properties:
      identifier: identifier
      orgId: org_id
      projectId: project_id
      name: name
      migrationType: Liquibase
      service: service1
      type: Script
      tags:
        - foo:bar
        - bar:foo
      changelogScript:
        image: plugins/image
        command: echo \"hello dbops\"
        shell: sh/bash
        location: db/example-changelog.yaml
  flywayRepositoryTest:
    type: harness:platform:DbSchema
    name: flyway_repository_test
    properties:
      identifier: identifier
      orgId: org_id
      projectId: project_id
      name: name
      service: service1
      type: Repository
      migrationType: Flyway
      tags:
        - foo:bar
        - bar:foo
      schemaSource:
        connector: gitConnector
        repo: TestRepo
        location: db/flyway/migrations
        toml: db/flyway.toml
        archivePath: path/to/archive.zip
  flywayScriptTest:
    type: harness:platform:DbSchema
    name: flyway_script_test
    properties:
      identifier: identifier
      orgId: org_id
      projectId: project_id
      name: name
      migrationType: Flyway
      service: service1
      type: Script
      tags:
        - foo:bar
        - bar:foo
      changelogScript:
        image: plugins/image
        command: echo \"hello dbops\"
        shell: sh/bash
        location: db/flyway/migrations
        toml: db/flyway.toml

Create DbSchema Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DbSchema(name: string, args: DbSchemaArgs, opts?: CustomResourceOptions);

@overload
def DbSchema(resource_name: str,
             args: DbSchemaArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def DbSchema(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             identifier: Optional[str] = None,
             org_id: Optional[str] = None,
             project_id: Optional[str] = None,
             changelog_script: Optional[DbSchemaChangelogScriptArgs] = None,
             description: Optional[str] = None,
             migration_type: Optional[str] = None,
             name: Optional[str] = None,
             schema_source: Optional[DbSchemaSchemaSourceArgs] = None,
             service: Optional[str] = None,
             tags: Optional[Sequence[str]] = None,
             type: Optional[str] = None)

func NewDbSchema(ctx *Context, name string, args DbSchemaArgs, opts ...ResourceOption) (*DbSchema, error)

public DbSchema(string name, DbSchemaArgs args, CustomResourceOptions? opts = null)

public DbSchema(String name, DbSchemaArgs args)
public DbSchema(String name, DbSchemaArgs args, CustomResourceOptions options)

type: harness:platform:DbSchema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DbSchemaArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DbSchemaArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DbSchemaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DbSchemaArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DbSchemaArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var dbSchemaResource = new Harness.Platform.DbSchema("dbSchemaResource", new()
{
    Identifier = "string",
    OrgId = "string",
    ProjectId = "string",
    ChangelogScript = new Harness.Platform.Inputs.DbSchemaChangelogScriptArgs
    {
        Command = "string",
        Image = "string",
        Location = "string",
        Shell = "string",
        Toml = "string",
    },
    Description = "string",
    MigrationType = "string",
    Name = "string",
    SchemaSource = new Harness.Platform.Inputs.DbSchemaSchemaSourceArgs
    {
        Connector = "string",
        Location = "string",
        ArchivePath = "string",
        Repo = "string",
        Toml = "string",
    },
    Service = "string",
    Tags = new[]
    {
        "string",
    },
    Type = "string",
});

example, err := platform.NewDbSchema(ctx, "dbSchemaResource", &platform.DbSchemaArgs{
	Identifier: pulumi.String("string"),
	OrgId:      pulumi.String("string"),
	ProjectId:  pulumi.String("string"),
	ChangelogScript: &platform.DbSchemaChangelogScriptArgs{
		Command:  pulumi.String("string"),
		Image:    pulumi.String("string"),
		Location: pulumi.String("string"),
		Shell:    pulumi.String("string"),
		Toml:     pulumi.String("string"),
	},
	Description:   pulumi.String("string"),
	MigrationType: pulumi.String("string"),
	Name:          pulumi.String("string"),
	SchemaSource: &platform.DbSchemaSchemaSourceArgs{
		Connector:   pulumi.String("string"),
		Location:    pulumi.String("string"),
		ArchivePath: pulumi.String("string"),
		Repo:        pulumi.String("string"),
		Toml:        pulumi.String("string"),
	},
	Service: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})

var dbSchemaResource = new DbSchema("dbSchemaResource", DbSchemaArgs.builder()
    .identifier("string")
    .orgId("string")
    .projectId("string")
    .changelogScript(DbSchemaChangelogScriptArgs.builder()
        .command("string")
        .image("string")
        .location("string")
        .shell("string")
        .toml("string")
        .build())
    .description("string")
    .migrationType("string")
    .name("string")
    .schemaSource(DbSchemaSchemaSourceArgs.builder()
        .connector("string")
        .location("string")
        .archivePath("string")
        .repo("string")
        .toml("string")
        .build())
    .service("string")
    .tags("string")
    .type("string")
    .build());

db_schema_resource = harness.platform.DbSchema("dbSchemaResource",
    identifier="string",
    org_id="string",
    project_id="string",
    changelog_script={
        "command": "string",
        "image": "string",
        "location": "string",
        "shell": "string",
        "toml": "string",
    },
    description="string",
    migration_type="string",
    name="string",
    schema_source={
        "connector": "string",
        "location": "string",
        "archive_path": "string",
        "repo": "string",
        "toml": "string",
    },
    service="string",
    tags=["string"],
    type="string")

const dbSchemaResource = new harness.platform.DbSchema("dbSchemaResource", {
    identifier: "string",
    orgId: "string",
    projectId: "string",
    changelogScript: {
        command: "string",
        image: "string",
        location: "string",
        shell: "string",
        toml: "string",
    },
    description: "string",
    migrationType: "string",
    name: "string",
    schemaSource: {
        connector: "string",
        location: "string",
        archivePath: "string",
        repo: "string",
        toml: "string",
    },
    service: "string",
    tags: ["string"],
    type: "string",
});

type: harness:platform:DbSchema
properties:
    changelogScript:
        command: string
        image: string
        location: string
        shell: string
        toml: string
    description: string
    identifier: string
    migrationType: string
    name: string
    orgId: string
    projectId: string
    schemaSource:
        archivePath: string
        connector: string
        location: string
        repo: string
        toml: string
    service: string
    tags:
        - string
    type: string

DbSchema Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DbSchema resource accepts the following input properties:

Identifier string: Unique identifier of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
ChangelogScript DbSchemaChangelogScript: Configuration to clone changeSets using script
Description string: Description of the resource.
MigrationType string: DB migration tool type. Valid values are any one of: Liquibase, Flyway
Name string: Name of the resource.
SchemaSource DbSchemaSchemaSource: Provides a connector and path at which to find the database schema representation
Service string: The service associated with schema
Tags List<string>: Tags to associate with the resource.
Type string: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

Identifier string: Unique identifier of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
ChangelogScript DbSchemaChangelogScriptArgs: Configuration to clone changeSets using script
Description string: Description of the resource.
MigrationType string: DB migration tool type. Valid values are any one of: Liquibase, Flyway
Name string: Name of the resource.
SchemaSource DbSchemaSchemaSourceArgs: Provides a connector and path at which to find the database schema representation
Service string: The service associated with schema
Tags []string: Tags to associate with the resource.
Type string: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

identifier String: Unique identifier of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
changelogScript DbSchemaChangelogScript: Configuration to clone changeSets using script
description String: Description of the resource.
migrationType String: DB migration tool type. Valid values are any one of: Liquibase, Flyway
name String: Name of the resource.
schemaSource DbSchemaSchemaSource: Provides a connector and path at which to find the database schema representation
service String: The service associated with schema
tags List<String>: Tags to associate with the resource.
type String: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

identifier string: Unique identifier of the resource.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.
changelogScript DbSchemaChangelogScript: Configuration to clone changeSets using script
description string: Description of the resource.
migrationType string: DB migration tool type. Valid values are any one of: Liquibase, Flyway
name string: Name of the resource.
schemaSource DbSchemaSchemaSource: Provides a connector and path at which to find the database schema representation
service string: The service associated with schema
tags string[]: Tags to associate with the resource.
type string: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

identifier str: Unique identifier of the resource.
org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.
changelog_script DbSchemaChangelogScriptArgs: Configuration to clone changeSets using script
description str: Description of the resource.
migration_type str: DB migration tool type. Valid values are any one of: Liquibase, Flyway
name str: Name of the resource.
schema_source DbSchemaSchemaSourceArgs: Provides a connector and path at which to find the database schema representation
service str: The service associated with schema
tags Sequence[str]: Tags to associate with the resource.
type str: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

identifier String: Unique identifier of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
changelogScript Property Map: Configuration to clone changeSets using script
description String: Description of the resource.
migrationType String: DB migration tool type. Valid values are any one of: Liquibase, Flyway
name String: Name of the resource.
schemaSource Property Map: Provides a connector and path at which to find the database schema representation
service String: The service associated with schema
tags List<String>: Tags to associate with the resource.
type String: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

Outputs

All input properties are implicitly available as output properties. Additionally, the DbSchema resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing DbSchema Resource

Get an existing DbSchema resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DbSchemaState, opts?: CustomResourceOptions): DbSchema

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        changelog_script: Optional[DbSchemaChangelogScriptArgs] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        migration_type: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        schema_source: Optional[DbSchemaSchemaSourceArgs] = None,
        service: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        type: Optional[str] = None) -> DbSchema

func GetDbSchema(ctx *Context, name string, id IDInput, state *DbSchemaState, opts ...ResourceOption) (*DbSchema, error)

public static DbSchema Get(string name, Input<string> id, DbSchemaState? state, CustomResourceOptions? opts = null)

public static DbSchema get(String name, Output<String> id, DbSchemaState state, CustomResourceOptions options)

resources:  _:    type: harness:platform:DbSchema    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ChangelogScript DbSchemaChangelogScript: Configuration to clone changeSets using script
Description string: Description of the resource.
Identifier string: Unique identifier of the resource.
MigrationType string: DB migration tool type. Valid values are any one of: Liquibase, Flyway
Name string: Name of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
SchemaSource DbSchemaSchemaSource: Provides a connector and path at which to find the database schema representation
Service string: The service associated with schema
Tags List<string>: Tags to associate with the resource.
Type string: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

ChangelogScript DbSchemaChangelogScriptArgs: Configuration to clone changeSets using script
Description string: Description of the resource.
Identifier string: Unique identifier of the resource.
MigrationType string: DB migration tool type. Valid values are any one of: Liquibase, Flyway
Name string: Name of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
SchemaSource DbSchemaSchemaSourceArgs: Provides a connector and path at which to find the database schema representation
Service string: The service associated with schema
Tags []string: Tags to associate with the resource.
Type string: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

changelogScript DbSchemaChangelogScript: Configuration to clone changeSets using script
description String: Description of the resource.
identifier String: Unique identifier of the resource.
migrationType String: DB migration tool type. Valid values are any one of: Liquibase, Flyway
name String: Name of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
schemaSource DbSchemaSchemaSource: Provides a connector and path at which to find the database schema representation
service String: The service associated with schema
tags List<String>: Tags to associate with the resource.
type String: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

changelogScript DbSchemaChangelogScript: Configuration to clone changeSets using script
description string: Description of the resource.
identifier string: Unique identifier of the resource.
migrationType string: DB migration tool type. Valid values are any one of: Liquibase, Flyway
name string: Name of the resource.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.
schemaSource DbSchemaSchemaSource: Provides a connector and path at which to find the database schema representation
service string: The service associated with schema
tags string[]: Tags to associate with the resource.
type string: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

changelog_script DbSchemaChangelogScriptArgs: Configuration to clone changeSets using script
description str: Description of the resource.
identifier str: Unique identifier of the resource.
migration_type str: DB migration tool type. Valid values are any one of: Liquibase, Flyway
name str: Name of the resource.
org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.
schema_source DbSchemaSchemaSourceArgs: Provides a connector and path at which to find the database schema representation
service str: The service associated with schema
tags Sequence[str]: Tags to associate with the resource.
type str: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

changelogScript Property Map: Configuration to clone changeSets using script
description String: Description of the resource.
identifier String: Unique identifier of the resource.
migrationType String: DB migration tool type. Valid values are any one of: Liquibase, Flyway
name String: Name of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
schemaSource Property Map: Provides a connector and path at which to find the database schema representation
service String: The service associated with schema
tags List<String>: Tags to associate with the resource.
type String: Type of the database schema. Valid values are: SCRIPT, REPOSITORY

Supporting Types

DbSchemaChangelogScript, DbSchemaChangelogScriptArgs

Command string: Script to clone changeSets
Image string: The fully-qualified name (FQN) of the image
Location string: Path to changeLog file
Shell string: Type of the shell. For example Sh or Bash
Toml string: Config file, to define various settings and properties for managing database schema change

Command string: Script to clone changeSets
Image string: The fully-qualified name (FQN) of the image
Location string: Path to changeLog file
Shell string: Type of the shell. For example Sh or Bash
Toml string: Config file, to define various settings and properties for managing database schema change

command String: Script to clone changeSets
image String: The fully-qualified name (FQN) of the image
location String: Path to changeLog file
shell String: Type of the shell. For example Sh or Bash
toml String: Config file, to define various settings and properties for managing database schema change

command string: Script to clone changeSets
image string: The fully-qualified name (FQN) of the image
location string: Path to changeLog file
shell string: Type of the shell. For example Sh or Bash
toml string: Config file, to define various settings and properties for managing database schema change

command str: Script to clone changeSets
image str: The fully-qualified name (FQN) of the image
location str: Path to changeLog file
shell str: Type of the shell. For example Sh or Bash
toml str: Config file, to define various settings and properties for managing database schema change

command String: Script to clone changeSets
image String: The fully-qualified name (FQN) of the image
location String: Path to changeLog file
shell String: Type of the shell. For example Sh or Bash
toml String: Config file, to define various settings and properties for managing database schema change

DbSchemaSchemaSource, DbSchemaSchemaSourceArgs

Connector string: Connector to repository at which to find details about the database schema
Location string: The path within the specified repository at which to find details about the database schema
ArchivePath string: If connector type is artifactory, path to the archive file which contains the changeLog
Repo string: If connector url is of account, which repository to connect to using the connector
Toml string: Config file, to define various settings and properties for managing database schema change

Connector string: Connector to repository at which to find details about the database schema
Location string: The path within the specified repository at which to find details about the database schema
ArchivePath string: If connector type is artifactory, path to the archive file which contains the changeLog
Repo string: If connector url is of account, which repository to connect to using the connector
Toml string: Config file, to define various settings and properties for managing database schema change

connector String: Connector to repository at which to find details about the database schema
location String: The path within the specified repository at which to find details about the database schema
archivePath String: If connector type is artifactory, path to the archive file which contains the changeLog
repo String: If connector url is of account, which repository to connect to using the connector
toml String: Config file, to define various settings and properties for managing database schema change

connector string: Connector to repository at which to find details about the database schema
location string: The path within the specified repository at which to find details about the database schema
archivePath string: If connector type is artifactory, path to the archive file which contains the changeLog
repo string: If connector url is of account, which repository to connect to using the connector
toml string: Config file, to define various settings and properties for managing database schema change

connector str: Connector to repository at which to find details about the database schema
location str: The path within the specified repository at which to find details about the database schema
archive_path str: If connector type is artifactory, path to the archive file which contains the changeLog
repo str: If connector url is of account, which repository to connect to using the connector
toml str: Config file, to define various settings and properties for managing database schema change

connector String: Connector to repository at which to find details about the database schema
location String: The path within the specified repository at which to find details about the database schema
archivePath String: If connector type is artifactory, path to the archive file which contains the changeLog
repo String: If connector url is of account, which repository to connect to using the connector
toml String: Config file, to define various settings and properties for managing database schema change

Import

The pulumi import command can be used, for example:

Import project level db schema

$ pulumi import harness:platform/dbSchema:DbSchema example <org_id>/<project_id>/<db_schema_id>

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: harness pulumi/pulumi-harness
License: Apache-2.0
Notes: This Pulumi package is based on the harness Terraform Provider.

Harness v0.9.3 published on Tuesday, Nov 25, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-harness

harness.platform.DbSchema

On this page

On this page

Example Usage

Create DbSchema Resource

Constructor syntax

Parameters

Constructor example

DbSchema Resource Properties

Inputs

Outputs

Look up Existing DbSchema Resource

Supporting Types

DbSchemaChangelogScript, DbSchemaChangelogScriptArgs

DbSchemaSchemaSource, DbSchemaSchemaSourceArgs

Import

Package Details

On this page

On this page