Harness v0.7.3, Apr 18 25

Harness v0.7.3 published on Friday, Apr 18, 2025 by Pulumi

harness.platform.getDbSchema

Explore with Pulumi AI

Harness v0.7.3 published on Friday, Apr 18, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = harness.platform.getDbSchema({
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
});

import pulumi
import pulumi_harness as harness

example = harness.platform.get_db_schema(identifier="identifier",
    org_id="org_id",
    project_id="project_id")

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.LookupDbSchema(ctx, &platform.LookupDbSchemaArgs{
			Identifier: "identifier",
			OrgId:      "org_id",
			ProjectId:  "project_id",
		}, nil)
		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 example = Harness.Platform.GetDbSchema.Invoke(new()
    {
        Identifier = "identifier",
        OrgId = "org_id",
        ProjectId = "project_id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.PlatformFunctions;
import com.pulumi.harness.platform.inputs.GetDbSchemaArgs;
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 example = PlatformFunctions.getDbSchema(GetDbSchemaArgs.builder()
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: harness:platform:getDbSchema
      arguments:
        identifier: identifier
        orgId: org_id
        projectId: project_id

Using getDbSchema

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.

TypeScript
Python
Go
C#
Java
YAML

function getDbSchema(args: GetDbSchemaArgs, opts?: InvokeOptions): Promise<GetDbSchemaResult>
function getDbSchemaOutput(args: GetDbSchemaOutputArgs, opts?: InvokeOptions): Output<GetDbSchemaResult>

def get_db_schema(changelog_script: Optional[GetDbSchemaChangelogScript] = None,
                  identifier: Optional[str] = None,
                  name: Optional[str] = None,
                  org_id: Optional[str] = None,
                  project_id: Optional[str] = None,
                  schema_sources: Optional[Sequence[GetDbSchemaSchemaSource]] = None,
                  type: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDbSchemaResult
def get_db_schema_output(changelog_script: Optional[pulumi.Input[GetDbSchemaChangelogScriptArgs]] = None,
                  identifier: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  org_id: Optional[pulumi.Input[str]] = None,
                  project_id: Optional[pulumi.Input[str]] = None,
                  schema_sources: Optional[pulumi.Input[Sequence[pulumi.Input[GetDbSchemaSchemaSourceArgs]]]] = None,
                  type: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDbSchemaResult]

func LookupDbSchema(ctx *Context, args *LookupDbSchemaArgs, opts ...InvokeOption) (*LookupDbSchemaResult, error)
func LookupDbSchemaOutput(ctx *Context, args *LookupDbSchemaOutputArgs, opts ...InvokeOption) LookupDbSchemaResultOutput

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

public static class GetDbSchema 
{
    public static Task<GetDbSchemaResult> InvokeAsync(GetDbSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetDbSchemaResult> Invoke(GetDbSchemaInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDbSchemaResult> getDbSchema(GetDbSchemaArgs args, InvokeOptions options)
public static Output<GetDbSchemaResult> getDbSchema(GetDbSchemaArgs args, InvokeOptions options)

fn::invoke:
  function: harness:platform/getDbSchema:getDbSchema
  arguments:
    # arguments dictionary

The following arguments are supported:

Identifier string: Unique identifier of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
ChangelogScript GetDbSchemaChangelogScript
Name string: Name of the resource.
SchemaSources List<GetDbSchemaSchemaSource>: Provides a connector and path at which to find the database schema representation
Type string

Identifier string: Unique identifier of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
ChangelogScript GetDbSchemaChangelogScript
Name string: Name of the resource.
SchemaSources []GetDbSchemaSchemaSource: Provides a connector and path at which to find the database schema representation
Type string

identifier String: Unique identifier of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
changelogScript GetDbSchemaChangelogScript
name String: Name of the resource.
schemaSources List<GetDbSchemaSchemaSource>: Provides a connector and path at which to find the database schema representation
type String

identifier string: Unique identifier of the resource.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.
changelogScript GetDbSchemaChangelogScript
name string: Name of the resource.
schemaSources GetDbSchemaSchemaSource[]: Provides a connector and path at which to find the database schema representation
type string

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 GetDbSchemaChangelogScript
name str: Name of the resource.
schema_sources Sequence[GetDbSchemaSchemaSource]: Provides a connector and path at which to find the database schema representation
type str

identifier String: Unique identifier of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
changelogScript Property Map
name String: Name of the resource.
schemaSources List<Property Map>: Provides a connector and path at which to find the database schema representation
type String

getDbSchema Result

The following output properties are available:

Description string: Description of the resource.
Id string: The provider-assigned unique ID for this managed resource.
Identifier string: Unique identifier of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
Service string: The service associated with schema
Tags List<string>: Tags to associate with the resource.
ChangelogScript GetDbSchemaChangelogScript
Name string: Name of the resource.
SchemaSources List<GetDbSchemaSchemaSource>: Provides a connector and path at which to find the database schema representation
Type string

Description string: Description of the resource.
Id string: The provider-assigned unique ID for this managed resource.
Identifier string: Unique identifier of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
Service string: The service associated with schema
Tags []string: Tags to associate with the resource.
ChangelogScript GetDbSchemaChangelogScript
Name string: Name of the resource.
SchemaSources []GetDbSchemaSchemaSource: Provides a connector and path at which to find the database schema representation
Type string

description String: Description of the resource.
id String: The provider-assigned unique ID for this managed resource.
identifier String: Unique identifier of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
service String: The service associated with schema
tags List<String>: Tags to associate with the resource.
changelogScript GetDbSchemaChangelogScript
name String: Name of the resource.
schemaSources List<GetDbSchemaSchemaSource>: Provides a connector and path at which to find the database schema representation
type String

description string: Description of the resource.
id string: The provider-assigned unique ID for this managed resource.
identifier string: Unique identifier of the resource.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.
service string: The service associated with schema
tags string[]: Tags to associate with the resource.
changelogScript GetDbSchemaChangelogScript
name string: Name of the resource.
schemaSources GetDbSchemaSchemaSource[]: Provides a connector and path at which to find the database schema representation
type string

description str: Description of the resource.
id str: The provider-assigned unique ID for this managed resource.
identifier str: Unique identifier of the resource.
org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.
service str: The service associated with schema
tags Sequence[str]: Tags to associate with the resource.
changelog_script GetDbSchemaChangelogScript
name str: Name of the resource.
schema_sources Sequence[GetDbSchemaSchemaSource]: Provides a connector and path at which to find the database schema representation
type str

description String: Description of the resource.
id String: The provider-assigned unique ID for this managed resource.
identifier String: Unique identifier of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
service String: The service associated with schema
tags List<String>: Tags to associate with the resource.
changelogScript Property Map
name String: Name of the resource.
schemaSources List<Property Map>: Provides a connector and path at which to find the database schema representation
type String

Supporting Types

GetDbSchemaChangelogScript

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

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

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

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

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

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

GetDbSchemaSchemaSource

ArchivePath string: If connector type is artifactory, path to the archive file which contains the changeLog
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
Repo string: If connector url is of account, which repository to connect to using the connector

ArchivePath string: If connector type is artifactory, path to the archive file which contains the changeLog
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
Repo string: If connector url is of account, which repository to connect to using the connector

archivePath String: If connector type is artifactory, path to the archive file which contains the changeLog
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
repo String: If connector url is of account, which repository to connect to using the connector

archivePath string: If connector type is artifactory, path to the archive file which contains the changeLog
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
repo string: If connector url is of account, which repository to connect to using the connector

archive_path str: If connector type is artifactory, path to the archive file which contains the changeLog
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
repo str: If connector url is of account, which repository to connect to using the connector

archivePath String: If connector type is artifactory, path to the archive file which contains the changeLog
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
repo String: If connector url is of account, which repository to connect to using the connector

Package Details

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

Harness v0.7.3 published on Friday, Apr 18, 2025 by Pulumi

pulumi/pulumi-harness

harness.platform.getDbSchema

On this page

On this page

Example Usage

Using getDbSchema

getDbSchema Result

Supporting Types

GetDbSchemaChangelogScript

GetDbSchemaSchemaSource

Package Details

On this page

On this page