Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Planetscale Provider
  4. API Docs
  5. getNekiBranch
Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.getNekiBranch

Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    NekiBranch DataSource

    Example Usage

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

const myNekibranch = planetscale.getNekiBranch({
    database: "...my_database...",
    id: "...my_id...",
    organization: "...my_organization...",
});

    import pulumi
import pulumi_planetscale as planetscale

my_nekibranch = planetscale.get_neki_branch(database="...my_database...",
    id="...my_id...",
    organization="...my_organization...")

    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 {
		_, err := planetscale.LookupNekiBranch(ctx, &planetscale.LookupNekiBranchArgs{
			Database:     "...my_database...",
			Id:           "...my_id...",
			Organization: "...my_organization...",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myNekibranch = Planetscale.GetNekiBranch.Invoke(new()
    {
        Database = "...my_database...",
        Id = "...my_id...",
        Organization = "...my_organization...",
    });

});

    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.GetNekiBranchArgs;
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 myNekibranch = PlanetscaleFunctions.getNekiBranch(GetNekiBranchArgs.builder()
            .database("...my_database...")
            .id("...my_id...")
            .organization("...my_organization...")
            .build());

    }
}

    variables:
  myNekibranch:
    fn::invoke:
      function: planetscale:getNekiBranch
      arguments:
        database: '...my_database...'
        id: '...my_id...'
        organization: '...my_organization...'

    Example coming soon!

    Using getNekiBranch

    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 getNekiBranch(args: GetNekiBranchArgs, opts?: InvokeOptions): Promise<GetNekiBranchResult>
function getNekiBranchOutput(args: GetNekiBranchOutputArgs, opts?: InvokeOutputOptions): Output<GetNekiBranchResult>
    def get_neki_branch(database: Optional[str] = None,
                    id: Optional[str] = None,
                    organization: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNekiBranchResult
def get_neki_branch_output(database: pulumi.Input[Optional[str]] = None,
                    id: pulumi.Input[Optional[str]] = None,
                    organization: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetNekiBranchResult]
    func LookupNekiBranch(ctx *Context, args *LookupNekiBranchArgs, opts ...InvokeOption) (*LookupNekiBranchResult, error)
func LookupNekiBranchOutput(ctx *Context, args *LookupNekiBranchOutputArgs, opts ...InvokeOption) LookupNekiBranchResultOutput

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

    public static class GetNekiBranch 
{
    public static Task<GetNekiBranchResult> InvokeAsync(GetNekiBranchArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiBranchResult> Invoke(GetNekiBranchInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiBranchResult> Invoke(GetNekiBranchInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetNekiBranchResult> getNekiBranch(GetNekiBranchArgs args, InvokeOptions options)
public static Output<GetNekiBranchResult> getNekiBranch(GetNekiBranchArgs args, InvokeOptions options)
public static Output<GetNekiBranchResult> getNekiBranch(GetNekiBranchArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: planetscale:index/getNekiBranch:getNekiBranch
  arguments:
    # arguments dictionary
    data "planetscale_get_neki_branch" "name" {
    # arguments
}

    The following arguments are supported:

    Database string
    Database name slug from list_databases. Example: app-db.
    Id string
    The ID of the branch
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Database string
    Database name slug from list_databases. Example: app-db.
    Id string
    The ID of the branch
    Organization string
    Organization name slug from list_organizations. Example: acme.
    database string
    Database name slug from list_databases. Example: app-db.
    id string
    The ID of the branch
    organization string
    Organization name slug from list_organizations. Example: acme.
    database String
    Database name slug from list_databases. Example: app-db.
    id String
    The ID of the branch
    organization String
    Organization name slug from list_organizations. Example: acme.
    database string
    Database name slug from list_databases. Example: app-db.
    id string
    The ID of the branch
    organization string
    Organization name slug from list_organizations. Example: acme.
    database str
    Database name slug from list_databases. Example: app-db.
    id str
    The ID of the branch
    organization str
    Organization name slug from list_organizations. Example: acme.
    database String
    Database name slug from list_databases. Example: app-db.
    id String
    The ID of the branch
    organization String
    Organization name slug from list_organizations. Example: acme.

    getNekiBranch Result

    The following output properties are available:

    Database string
    Database name slug from list_databases. Example: app-db.
    DeletionProtected bool
    Whether deletion protection is enabled for the branch
    Id string
    The ID of the branch
    Name string
    The name of the branch
    Organization string
    Organization name slug from list_organizations. Example: acme.
    ParentBranch string
    The name of the parent branch from which the branch was created
    Region string
    The region slug where the branch is hosted.
    State string
    The current state of the branch
    Database string
    Database name slug from list_databases. Example: app-db.
    DeletionProtected bool
    Whether deletion protection is enabled for the branch
    Id string
    The ID of the branch
    Name string
    The name of the branch
    Organization string
    Organization name slug from list_organizations. Example: acme.
    ParentBranch string
    The name of the parent branch from which the branch was created
    Region string
    The region slug where the branch is hosted.
    State string
    The current state of the branch
    database string
    Database name slug from list_databases. Example: app-db.
    deletion_protected bool
    Whether deletion protection is enabled for the branch
    id string
    The ID of the branch
    name string
    The name of the branch
    organization string
    Organization name slug from list_organizations. Example: acme.
    parent_branch string
    The name of the parent branch from which the branch was created
    region string
    The region slug where the branch is hosted.
    state string
    The current state of the branch
    database String
    Database name slug from list_databases. Example: app-db.
    deletionProtected Boolean
    Whether deletion protection is enabled for the branch
    id String
    The ID of the branch
    name String
    The name of the branch
    organization String
    Organization name slug from list_organizations. Example: acme.
    parentBranch String
    The name of the parent branch from which the branch was created
    region String
    The region slug where the branch is hosted.
    state String
    The current state of the branch
    database string
    Database name slug from list_databases. Example: app-db.
    deletionProtected boolean
    Whether deletion protection is enabled for the branch
    id string
    The ID of the branch
    name string
    The name of the branch
    organization string
    Organization name slug from list_organizations. Example: acme.
    parentBranch string
    The name of the parent branch from which the branch was created
    region string
    The region slug where the branch is hosted.
    state string
    The current state of the branch
    database str
    Database name slug from list_databases. Example: app-db.
    deletion_protected bool
    Whether deletion protection is enabled for the branch
    id str
    The ID of the branch
    name str
    The name of the branch
    organization str
    Organization name slug from list_organizations. Example: acme.
    parent_branch str
    The name of the parent branch from which the branch was created
    region str
    The region slug where the branch is hosted.
    state str
    The current state of the branch
    database String
    Database name slug from list_databases. Example: app-db.
    deletionProtected Boolean
    Whether deletion protection is enabled for the branch
    id String
    The ID of the branch
    name String
    The name of the branch
    organization String
    Organization name slug from list_organizations. Example: acme.
    parentBranch String
    The name of the parent branch from which the branch was created
    region String
    The region slug where the branch is hosted.
    state String
    The current state of the branch

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    Viewing docs for planetscale 1.11.0
    published on Friday, Sep 18, 2026 by planetscale
    Schema (JSON)
    planetscale/terraform-provider-planetscale

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial