GET
/
v1
/
instances
/
{instance}
/
databases
/
{database}
/
changelogs
{
  "changelogs": [
    {
      "name": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "status": "STATUS_UNSPECIFIED",
      "statement": "<string>",
      "statementSize": "<string>",
      "statementSheet": "<string>",
      "schema": "<string>",
      "schemaSize": "<string>",
      "prevSchema": "<string>",
      "prevSchemaSize": "<string>",
      "issue": "<string>",
      "taskRun": "<string>",
      "version": "<string>",
      "revision": "<string>",
      "changedResources": {
        "databases": [
          {
            "name": "<string>",
            "schemas": [
              {
                "name": "<string>",
                "tables": [
                  {
                    "name": "<string>",
                    "tableRows": "<string>",
                    "ranges": [
                      {
                        "start": 123,
                        "end": 123
                      }
                    ]
                  }
                ],
                "views": [
                  {
                    "name": "<string>",
                    "ranges": [
                      {
                        "start": 123,
                        "end": 123
                      }
                    ]
                  }
                ],
                "functions": [
                  {
                    "name": "<string>",
                    "ranges": [
                      {
                        "start": 123,
                        "end": 123
                      }
                    ]
                  }
                ],
                "procedures": [
                  {
                    "name": "<string>",
                    "ranges": [
                      {
                        "start": 123,
                        "end": 123
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      "type": "TYPE_UNSPECIFIED"
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
instance
string
required

The instance id.

​
database
string
required

The database id.

Query Parameters

​
pageSize
integer

The maximum number of changelogs to return. The service may return fewer than this value. If unspecified, at most 10 changelogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from the previous call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided must match the call that provided the page token.

​
view
enum<string>
Available options:
CHANGELOG_VIEW_UNSPECIFIED,
CHANGELOG_VIEW_BASIC,
CHANGELOG_VIEW_FULL
​
filter
string

The filter of the changelogs. follow the ebnf syntax. Support filter by type, source or table. For example: table = "tableExists('{database}', '{schema}', '{table}')" table = "tableExists('db', 'public', 'table1') || tableExists('db', 'public', 'table2')"

The table filter follow the CEL syntax. currently, we have one function for CEL:

  • tableExists(database, schema, table): return true if the table exists in changed resources.

examples: Use tableExists("db", "public", "table1") to filter the changelogs which have the table "table1" in the schema "public" of the database "db". For MySQL, the schema is always "", such as tableExists("db", "", "table1").

Combine multiple functions with "&&" and "||", we MUST use the Disjunctive Normal Form(DNF). In other words, the CEL expression consists of several parts connected by OR operators. For example, the following expression is valid: ( tableExists("db", "public", "table1") && tableExists("db", "public", "table2") ) || ( tableExists("db", "public", "table3") )

Response

200
application/json

OK

The response is of type object.