/show/wal

URL: http://<db.host>:<db.port>/show/wal

Requests table write-ahead log (WAL) properties. Returns information about the requested table WAL entries.

Input Parameter Description

Name

Type

Description

table_names

array of strings

List of tables to query. An asterisk returns all tables.

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)

Parameter Description

show_settings

If true include a map of the WAL settings for the requested tables. The default value is true. The supported values are:

true
false

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'show_wal_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /show/wal endpoint:

Name	Type	Description
table_names	array of strings	List of returned tables.
sizes	array of arrays of longs	List of current WAL usage.
capacities	array of longs	List of WAL capacities.
uncommitted	array of arrays of longs	List of number of uncommitted entries.
settings	array of maps of string to strings	List of table WAL settings.
info	map of string to strings	Additional information.

Empty string in case of an error.