sqladmin1 命令行界面（CLI）允许您在终端中方便地使用Google SQL Admin服务的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其直接重定向到文件，而无需考虑shell的能力。错误将打印到标准错误，并导致程序的退出代码不为零。

如果请求数据结构，这些结构将作为格式化的JSON返回，以便作为其他工具的输入。

有关SQL Admin API的其他所有信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面：

cargo install google-sqladmin1-cli

在github上找到源代码。

用法

本文档是根据SQL Admin API的20220226修订版生成的。CLI的版本是3.1.0。

sqladmin1 [options]
        backup-runs
                delete <project> <instance> <id> [-p <v>]... [-o <out>]
                get <project> <instance> <id> [-p <v>]... [-o <out>]
                insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> <instance> [-p <v>]... [-o <out>]
        connect
                generate-ephemeral <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                get <project> <instance> [-p <v>]... [-o <out>]
        databases
                delete <project> <instance> <database> [-p <v>]... [-o <out>]
                get <project> <instance> <database> [-p <v>]... [-o <out>]
                insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> <instance> [-p <v>]... [-o <out>]
                patch <project> <instance> <database> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project> <instance> <database> (-r <kv>)... [-p <v>]... [-o <out>]
        flags
                list [-p <v>]... [-o <out>]
        instances
                add-server-ca <project> <instance> [-p <v>]... [-o <out>]
                clone <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <instance> [-p <v>]... [-o <out>]
                demote-master <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                export <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                failover <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                get <project> <instance> [-p <v>]... [-o <out>]
                import <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                insert <project> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> [-p <v>]... [-o <out>]
                list-server-cas <project> <instance> [-p <v>]... [-o <out>]
                patch <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                promote-replica <project> <instance> [-p <v>]... [-o <out>]
                reset-ssl-config <project> <instance> [-p <v>]... [-o <out>]
                restart <project> <instance> [-p <v>]... [-o <out>]
                restore-backup <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                rotate-server-ca <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                start-replica <project> <instance> [-p <v>]... [-o <out>]
                stop-replica <project> <instance> [-p <v>]... [-o <out>]
                truncate-log <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
        operations
                get <project> <operation> [-p <v>]... [-o <out>]
                list <project> [-p <v>]... [-o <out>]
        projects
                instances-reschedule-maintenance <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-start-external-sync <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-verify-external-sync-settings <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
        ssl-certs
                create-ephemeral <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <instance> <sha1-fingerprint> [-p <v>]... [-o <out>]
                get <project> <instance> <sha1-fingerprint> [-p <v>]... [-o <out>]
                insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> <instance> [-p <v>]... [-o <out>]
        tiers
                list <project> [-p <v>]... [-o <out>]
        users
                delete <project> <instance> [-p <v>]... [-o <out>]
                insert <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> <instance> [-p <v>]... [-o <out>]
                update <project> <instance> (-r <kv>)... [-p <v>]... [-o <out>]
  sqladmin1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在~/.google-service-cli目录中的JSON文件中，这些文件以sqladmin1-为前缀。您可以使用--config-dir标志在每个调用基础上更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数API都需要用户对任何请求进行身份验证。如果是这种情况，则作用域确定授予的权限集。这些的粒度通常不超过只读或完全访问。

如果没有设置，系统将自动选择最小的可行作用域，例如，当调用只读方法时，它将只请求只读作用域。您可以使用--scope标志直接指定作用域。所有适用的作用域都在相应方法的CLI文档中记录。

首次使用作用域时，会询问用户权限。根据CLI提供的说明进行授权或拒绝。

如果用户已验证作用域，相关信息将作为JSON存储在配置目录中，例如：~/.google-service-cli/sqladmin1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，需要使用Google开发者控制台进行注册。然后逐个为应用程序启用它可能使用的API。大多数API可以免费使用，并且有每日配额。

为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI，CLI附带了一个默认的应用程序密钥，并相应地进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题：~/.google-service-cli/sqladmin1-secret.json，假设已为其启用了所需的sqladmin API。此类密钥文件可以从Google开发者控制台的APIs & auth -> Credentials -> Download JSON下载并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI尽力提供可用的错误消息，但有时可能希望知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信直接输出到标准错误作为-是来实现的。

使用--debug标志将使用Debug表示法将错误打印到标准错误。

您可以考虑将标准错误重定向到文件，以便于使用，例如：sqladmin1 --debug <资源> <方法> [选项] 2>debug.txt。