1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getBranchSchemaLint
planetscale 0.6.0 published on Sunday, Apr 27, 2025 by planetscale
planetscale/terraform-provider-planetscale

planetscale.getBranchSchemaLint

Get Started
planetscale logo
planetscale 0.6.0 published on Sunday, Apr 27, 2025 by planetscale
planetscale/terraform-provider-planetscale

    Linting errors for the schema of a PlanetScale branch.

    Example Usage

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

const example = planetscale.getBranchSchemaLint({
    organization: "example.com",
    database: "example_db",
    branch: "main",
});
export const schemaLint = example;

    import pulumi
import pulumi_planetscale as planetscale

example = planetscale.get_branch_schema_lint(organization="example.com",
    database="example_db",
    branch="main")
pulumi.export("schemaLint", example)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetBranchSchemaLint(ctx, &planetscale.GetBranchSchemaLintArgs{
			Organization: "example.com",
			Database:     "example_db",
			Branch:       "main",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("schemaLint", example)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Planetscale.GetBranchSchemaLint.Invoke(new()
    {
        Organization = "example.com",
        Database = "example_db",
        Branch = "main",
    });

    return new Dictionary<string, object?>
    {
        ["schemaLint"] = example,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetBranchSchemaLintArgs;
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 = PlanetscaleFunctions.getBranchSchemaLint(GetBranchSchemaLintArgs.builder()
            .organization("example.com")
            .database("example_db")
            .branch("main")
            .build());

        ctx.export("schemaLint", example.applyValue(getBranchSchemaLintResult -> getBranchSchemaLintResult));
    }
}

    variables:
  example:
    fn::invoke:
      function: planetscale:getBranchSchemaLint
      arguments:
        organization: example.com
        database: example_db
        branch: main
outputs:
  schemaLint: ${example}

    Using getBranchSchemaLint

    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 getBranchSchemaLint(args: GetBranchSchemaLintArgs, opts?: InvokeOptions): Promise<GetBranchSchemaLintResult>
function getBranchSchemaLintOutput(args: GetBranchSchemaLintOutputArgs, opts?: InvokeOptions): Output<GetBranchSchemaLintResult>
    def get_branch_schema_lint(branch: Optional[str] = None,
                           database: Optional[str] = None,
                           organization: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBranchSchemaLintResult
def get_branch_schema_lint_output(branch: Optional[pulumi.Input[str]] = None,
                           database: Optional[pulumi.Input[str]] = None,
                           organization: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBranchSchemaLintResult]
    func GetBranchSchemaLint(ctx *Context, args *GetBranchSchemaLintArgs, opts ...InvokeOption) (*GetBranchSchemaLintResult, error)
func GetBranchSchemaLintOutput(ctx *Context, args *GetBranchSchemaLintOutputArgs, opts ...InvokeOption) GetBranchSchemaLintResultOutput

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

    public static class GetBranchSchemaLint 
{
    public static Task<GetBranchSchemaLintResult> InvokeAsync(GetBranchSchemaLintArgs args, InvokeOptions? opts = null)
    public static Output<GetBranchSchemaLintResult> Invoke(GetBranchSchemaLintInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBranchSchemaLintResult> getBranchSchemaLint(GetBranchSchemaLintArgs args, InvokeOptions options)
public static Output<GetBranchSchemaLintResult> getBranchSchemaLint(GetBranchSchemaLintArgs args, InvokeOptions options)

    fn::invoke:
  function: planetscale:index/getBranchSchemaLint:getBranchSchemaLint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Branch string
    Database string
    Organization string
    Branch string
    Database string
    Organization string
    branch String
    database String
    organization String
    branch string
    database string
    organization string
    branch String
    database String
    organization String

    getBranchSchemaLint Result

    The following output properties are available:

    Branch string
    Database string
    Errors List<GetBranchSchemaLintError>
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization string
    Branch string
    Database string
    Errors []GetBranchSchemaLintError
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization string
    branch String
    database String
    errors List<GetBranchSchemaLintError>
    id String
    The provider-assigned unique ID for this managed resource.
    organization String
    branch string
    database string
    errors GetBranchSchemaLintError[]
    id string
    The provider-assigned unique ID for this managed resource.
    organization string
    branch str
    database str
    errors Sequence[GetBranchSchemaLintError]
    id str
    The provider-assigned unique ID for this managed resource.
    organization str
    branch String
    database String
    errors List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    organization String

    Supporting Types

    GetBranchSchemaLintError

    AutoIncrementColumnNames List<string>
    A list of invalid auto-incremented columns.
    CharsetName string
    The charset of the schema.
    CheckConstraintName string
    The name of the invalid check constraint.
    ColumnName string
    The column in a table relevant to the error.
    DocsUrl string
    A link to the documentation related to the error.
    EngineName string
    The engine of the schema.
    EnumValue string
    The name of the invalid enum value.
    ErrorDescription string
    A description for the error that occurred.
    ForeignKeyColumnNames List<string>
    A list of invalid foreign key columns in a table.
    JsonPath string
    The path for an invalid JSON column.
    KeyspaceName string
    The keyspace of the schema with the error.
    LintError string
    Code representing.
    PartitionName string
    The name of the invalid partition in the schema.
    PartitioningType string
    The name of the invalid partitioning type.
    SubjectType string
    The subject for the errors.
    TableName string
    The table with the error.
    VindexName string
    The name of the vindex for the schema.
    AutoIncrementColumnNames []string
    A list of invalid auto-incremented columns.
    CharsetName string
    The charset of the schema.
    CheckConstraintName string
    The name of the invalid check constraint.
    ColumnName string
    The column in a table relevant to the error.
    DocsUrl string
    A link to the documentation related to the error.
    EngineName string
    The engine of the schema.
    EnumValue string
    The name of the invalid enum value.
    ErrorDescription string
    A description for the error that occurred.
    ForeignKeyColumnNames []string
    A list of invalid foreign key columns in a table.
    JsonPath string
    The path for an invalid JSON column.
    KeyspaceName string
    The keyspace of the schema with the error.
    LintError string
    Code representing.
    PartitionName string
    The name of the invalid partition in the schema.
    PartitioningType string
    The name of the invalid partitioning type.
    SubjectType string
    The subject for the errors.
    TableName string
    The table with the error.
    VindexName string
    The name of the vindex for the schema.
    autoIncrementColumnNames List<String>
    A list of invalid auto-incremented columns.
    charsetName String
    The charset of the schema.
    checkConstraintName String
    The name of the invalid check constraint.
    columnName String
    The column in a table relevant to the error.
    docsUrl String
    A link to the documentation related to the error.
    engineName String
    The engine of the schema.
    enumValue String
    The name of the invalid enum value.
    errorDescription String
    A description for the error that occurred.
    foreignKeyColumnNames List<String>
    A list of invalid foreign key columns in a table.
    jsonPath String
    The path for an invalid JSON column.
    keyspaceName String
    The keyspace of the schema with the error.
    lintError String
    Code representing.
    partitionName String
    The name of the invalid partition in the schema.
    partitioningType String
    The name of the invalid partitioning type.
    subjectType String
    The subject for the errors.
    tableName String
    The table with the error.
    vindexName String
    The name of the vindex for the schema.
    autoIncrementColumnNames string[]
    A list of invalid auto-incremented columns.
    charsetName string
    The charset of the schema.
    checkConstraintName string
    The name of the invalid check constraint.
    columnName string
    The column in a table relevant to the error.
    docsUrl string
    A link to the documentation related to the error.
    engineName string
    The engine of the schema.
    enumValue string
    The name of the invalid enum value.
    errorDescription string
    A description for the error that occurred.
    foreignKeyColumnNames string[]
    A list of invalid foreign key columns in a table.
    jsonPath string
    The path for an invalid JSON column.
    keyspaceName string
    The keyspace of the schema with the error.
    lintError string
    Code representing.
    partitionName string
    The name of the invalid partition in the schema.
    partitioningType string
    The name of the invalid partitioning type.
    subjectType string
    The subject for the errors.
    tableName string
    The table with the error.
    vindexName string
    The name of the vindex for the schema.
    auto_increment_column_names Sequence[str]
    A list of invalid auto-incremented columns.
    charset_name str
    The charset of the schema.
    check_constraint_name str
    The name of the invalid check constraint.
    column_name str
    The column in a table relevant to the error.
    docs_url str
    A link to the documentation related to the error.
    engine_name str
    The engine of the schema.
    enum_value str
    The name of the invalid enum value.
    error_description str
    A description for the error that occurred.
    foreign_key_column_names Sequence[str]
    A list of invalid foreign key columns in a table.
    json_path str
    The path for an invalid JSON column.
    keyspace_name str
    The keyspace of the schema with the error.
    lint_error str
    Code representing.
    partition_name str
    The name of the invalid partition in the schema.
    partitioning_type str
    The name of the invalid partitioning type.
    subject_type str
    The subject for the errors.
    table_name str
    The table with the error.
    vindex_name str
    The name of the vindex for the schema.
    autoIncrementColumnNames List<String>
    A list of invalid auto-incremented columns.
    charsetName String
    The charset of the schema.
    checkConstraintName String
    The name of the invalid check constraint.
    columnName String
    The column in a table relevant to the error.
    docsUrl String
    A link to the documentation related to the error.
    engineName String
    The engine of the schema.
    enumValue String
    The name of the invalid enum value.
    errorDescription String
    A description for the error that occurred.
    foreignKeyColumnNames List<String>
    A list of invalid foreign key columns in a table.
    jsonPath String
    The path for an invalid JSON column.
    keyspaceName String
    The keyspace of the schema with the error.
    lintError String
    Code representing.
    partitionName String
    The name of the invalid partition in the schema.
    partitioningType String
    The name of the invalid partitioning type.
    subjectType String
    The subject for the errors.
    tableName String
    The table with the error.
    vindexName String
    The name of the vindex for the schema.

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale logo
    planetscale 0.6.0 published on Sunday, Apr 27, 2025 by planetscale
    planetscale/terraform-provider-planetscale
      Meet Neo: Your AI Platform Teammate