List tables

List all tables in a given project. If more than limit tables exist, a cursor for pagination will be returned with the response.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
username
required
string (Username)

The name of the username (a.k.a. database) to be managed from the API

query Parameters
limit
integer [ 1 .. 100 ]
Default: 100

Limits the number of results to be returned. The maximum results returned by the server is 100 even if you specify a higher limit.

cursor
string

Cursor for paging through results.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
includeBuiltIns
string
Default: "no"

Determines if API should return built-in tables or not

Enum: "yes" "no"
Responses
200

List of tables paginated

400

The response for a bad request.

422

Validation Error

get/postgresgateway/tables/{username}
Request samples
custom_table_list = client.postgres_gateway.tables.list("myUserName", limit=5)

for table in client.postgres_gateway.tables:
    table # do something with the custom table

for table_list in client.postgres_gateway.tables(chunk_size=25):
    table_list # do something with the custom tables
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}