datamigration1 命令行界面（CLI）允许您从终端舒适地使用 Google 数据库迁移服务（DBMS）的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以使用标志将其定向到与您的shell功能无关的文件。错误将打印到标准错误，并将导致程序的退出代码非零。

如果请求数据结构，则这些数据结构将以漂亮的打印 JSON 返回，以便作为其他工具的输入。

有关数据库迁移服务 API 的其他一切信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-datamigration1-cli

在GitHub上找到源代码。

用法

此文档是从数据库迁移服务 API 的修订版 20240221 生成的。CLI 版本为 5.0.4。

datamigration1 [options]
        projects
                locations-connection-profiles-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connection-profiles-delete <name> [-p <v>]... [-o <out>]
                locations-connection-profiles-get <name> [-p <v>]... [-o <out>]
                locations-connection-profiles-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-connection-profiles-list <parent> [-p <v>]... [-o <out>]
                locations-connection-profiles-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connection-profiles-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connection-profiles-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-apply <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-commit <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-convert <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-delete <name> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-describe-conversion-workspace-revisions <conversion-workspace> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-describe-database-entities <conversion-workspace> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-get <name> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-list <parent> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-mapping-rules-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-mapping-rules-delete <name> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-mapping-rules-get <name> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-mapping-rules-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-mapping-rules-list <parent> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-rollback <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-search-background-jobs <conversion-workspace> [-p <v>]... [-o <out>]
                locations-conversion-workspaces-seed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-conversion-workspaces-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-fetch-static-ips <name> [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-migration-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-delete <name> [-p <v>]... [-o <out>]
                locations-migration-jobs-demote-destination <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-generate-ssh-script <migration-job> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-generate-tcp-proxy-script <migration-job> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-get <name> [-p <v>]... [-o <out>]
                locations-migration-jobs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-migration-jobs-list <parent> [-p <v>]... [-o <out>]
                locations-migration-jobs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-promote <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-restart <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-resume <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-start <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-stop <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-migration-jobs-verify <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-private-connections-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-private-connections-delete <name> [-p <v>]... [-o <out>]
                locations-private-connections-get <name> [-p <v>]... [-o <out>]
                locations-private-connections-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-private-connections-list <parent> [-p <v>]... [-o <out>]
                locations-private-connections-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-private-connections-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  datamigration1 --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 文件中，这些文件以 datamigration1- 为前缀。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

有关各种持久数据的更多信息，请参阅以下段落。

身份验证

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

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

首次使用作用域时，将要求用户授权。按照 CLI 给出的说明授权权限，或拒绝授权。

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

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

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件以便于使用，例如：datamigration1 --debug <resource> <method> [options] 2>debug.txt。