# Create an Indexes table

This endpoint creates one or more Indexes tables.

Method Path Operation*
POST /account/services/indexes create_indexes_table

*

In order for a user to perform the "create_indexes_table" operation, the "create_indexes_table" permission must be included in the list of allowed actions in the statement of the user's role.

# Request

Parameter Type In Description
properties dictionary body
Dictionary containing a list of property names and a list of data types of the corresponding properties.
Attribute Type Description
names list of strings Name/names of the property/properties. Each of the names must match the regular expression (opens new window) ^[a-z_][0-9a-z_]{0,63}$.
types list of string, value is "int", "bigint", "smallint", "integer", "numeric", "double precision", "json", "jsonb", "bool", "boolean", "character varying", "varchar", "text", "date", "time", "interval", "timestamp", "timestamptz", or "uuid". Data types of the corresponding properties.
rule string body Rule used to limit objects the Index can access.
templates dictionary body
Dictionary containing templates for "properties" (to determine the "names" and data "types" of the properties). The templates follow the Python string format() convention (see Format String Syntax (opens new window)).
Attribute Type Description
properties dictionary
Dictionary containing a list of property names and a list of data types of the corresponding properties.
Attribute Type Description
names list of strings Name (names) of the property (properties). Each of the names must match the regular expression (opens new window) ^[a-z_][0-9a-z_]{0,63}$.
types list of string, value is "int", "bigint", "smallint", "integer", "numeric", "double precision", "json", "jsonb", "bool", "boolean", "character varying", "varchar", "text", "date", "time", "interval", "timestamp", "timestamptz", or "uuid". Data types of the corresponding properties.

IMPORTANT NOTE

If the data types of a property and an Entry value do not match, it will not result in an error. The value will be null in the Indexes table.

# Response

Attribute Type Description
stats dictionary
Indexes table stats.
Attribute Type Description
table_size integer Size of the Indexes table in bytes.
index_size integer Size of all indexes attached to the Indexes table in bytes.
toast_size integer TOAST size in bytes.
total_size integer Total size in bytes.
properties dictionary
Dictionary containing a list of property names and a list of data types of the corresponding properties.
Attribute Type Description
names list of strings Name/names of the property/properties. Each of the names must match the regular expression (opens new window) ^[a-z_][0-9a-z_]{0,63}$.
types list of string, value is "int", "bigint", "smallint", "integer", "numeric", "double precision", "json", "jsonb", "bool", "boolean", "character varying", "varchar", "text", "date", "time", "interval", "timestamp", "timestamptz", or "uuid". Data types of the corresponding properties.
rule string Rule used to limit objects the Index can access.
templates dictionary
Dictionary containing [templates](../../introduction/templates.md for "properties" (to determine the "names" and data "types" of the properties). The templates follow the Python string format() convention (see Format String Syntax (opens new window)).
Attribute Type Description
properties dictionary
Dictionary containing a list of property names and a list of data types of the corresponding properties.
Attribute Type Description
names list of strings Name/names of the property/properties. Each of the names must match the regular expression (opens new window) ^[a-z_][0-9a-z_]{0,63}$.
types list of string, value is "int", "bigint", "smallint", "integer", "numeric", "double precision", "json", "jsonb", "bool", "boolean", "character varying", "varchar", "text", "date", "time", "interval", "timestamp", "timestamptz", or "uuid". Data types of the corresponding properties.

# Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status Codes section.