edbctl project

Suggest edits

Manages projects for organizing clusters and resources. Use this command to create, edit, view, and delete projects, making it easier to manage your database clusters efficiently.

Commands

edbctl project list

Lists all available projects and displays detailed information, including project ID, name, user count, cluster count, and tags. You can also filter results by project name or ID.

edbctl project list [options]

Where options are,

-n, --name string         Project name (optional). Filter the list by a specific project name.
-i, --id string           Project ID (optional). Filter the list by a specific project ID.
-c, --credential string   The credential which you created via 'credential create' command, the default is fetched from 'context_credential'
-o, --output string       [table json yaml xml] \(default "table")
-h, --help                help for list

This example shows how to list all the projects:

edbctl project list

edbctl project create

Creates a new project with a specified name and optional tags. Use this command to define and organize projects efficiently.

edbctl project create [options]

Where options are,

-n, --name string         Project name (required). The unique name for the project.
    --tags strings        Assign tags to the project in the format name=color (color is optional).
-c, --credential string   The credential which you created via 'credential create' command, the default is fetched from 'context_credential'
-y, --yes                 auto-confirm all confirmations
-h, --help                help for create

These examples shows how to create the projects using different options:

edbctl project create "My Project"
edbctl project create --name "My Project" --tags name2=blue
edbctl project create --name "My Project" --tags name2=#FF0000

edbctl project edit

Updates a project using its name or ID. You can rename the project and assign new tags. Make sure to provide the correct project name or ID before updating.

edbctl project edit {--id|--name} --new-name [options]

Where options are,

-i, --id string           Project ID (required if --name is not provided). The immutable unique identifier for a project.
-n, --name string         Project name (required if --id is not provided). The mutable unique identifier for a project.
-N, --new-name string     New name for the specified project.
    --tags strings        Assign tags to the project in the format name=color (color is optional).
-c, --credential string   The credential which you created via 'credential create' command, the default is fetched from 'context_credential'
-y, --yes                 auto-confirm all confirmations
-I, --interactive         Execute command interactively
-h, --help                help for edit

These examples shows how to update the projects:

edbctl project edit --id prj_MFq4M4EWEoalBAL3 --new-name "New Name"
edbctl project edit --name "Old Name" --new-name "New Name"
edbctl project edit --name "Old Name" --tags name2=blue

edbctl project delete

Deletes a specified project using its name or ID. Before deleting a project, you must permanently remove all its clusters. This action is irreversible, so ensure you have the correct project name or ID before proceeding.

edbctl project delete {--id|--name} [options]

Where options are,

-i, --id string           Project ID (required if --name is not provided). The immutable unique identifier for a project.
-n, --name string         Project name (required if --id is not provided). The mutable unique identifier for a project.
-c, --credential string   The credential which you created via 'credential create' command, the default is fetched from 'context_credential'
-y, --yes                 auto-confirm all confirmations
-h, --help                help for delete

Examples

edbctl project delete --id prj_MFq4M4EWEoalBAL3
edbctl project delete --name "My Project"
← Prev

edbctl operator

↑ Up

Hybrid Manager CLI - edbctl

Next →

Using the API

Could this page be better? Report a problem or suggest an addition!