Indexes & Dictionaries
Indexes API allows you to retrieve indexes, memory, and dictionaries for all tables across your Indexima cluster.
Please note that views don't have indexes, dictionaries, or memory footprints.
Retrieve indexes details
GET /api/monitor/get/indexes
Retrieve all indexes in your Indexima cluster.
Example:
curl http://myindeximacluster:8082/api/monitor/get/indexes \
-H "Authorization: $ACCESS_TOKEN" \
-H "Monitor-Target-Host: indexima-core-1" \
-H "Monitor-Target-Port: 9999" \
--compressed -s
Reply JSON Format:
Name | Type | Description |
---|---|---|
schemas.schema | String | The schema name |
schemas.tables.name | String | The table name |
schemas.tables.dico | Integer | The dictionaries memory size in bytes |
schemas.tables.indexes.name | String | The index name |
schemas.tables.indexes.count | Integer | The index number of rows |
schemas.tables.indexes.size | Integer | The index memory size in bytes |
schemas.tables.indexes.main | Boolean | If this index contains all the table columns (called a “main” index) |
Retrieve memory used for each index
GET /api/monitor/get/memory
Retrieve the memory used for all tables on each node of your cluster. This request is equivalent to executing a SHOW MEMORY ALL SQL command.
Example:
curl http://myindeximacluster:8082/api/monitor/get/memory \
-H "Authorization: $ACCESS_TOKEN" \
-H "Monitor-Target-Host: indexima-core-1" \
-H "Monitor-Target-Port: 9999" \
--compressed
Reply JSON Format:
Memory is represented by a tree structure with the following path :
Name of the node -> Schema -> Table -> Index
Name | Type | Description |
---|---|---|
loaded | Boolean | true if the current index is loaded in memory |
dictionary | Integer | The dictionaries memory size, in bytes |
size | Integer | The index memory size, in bytes |
count | Integer | This index number of lines |
bucketsize | Integer | The bucket disk size |
isLimited | Boolean | true if the parent table is a limited table |
isOnError | Boolean | true if this index is on error and can't be used |
isDimension | Boolean | true if the parent table is a dimension table |
isExternal | Boolean | true if the parent table is an external table |
isTemporary | Boolean | true if the parent table is a temporary table |
Retrieve dictionaries details
GET /api/monitor/get/dictionaries
Retrieve the dictionary details used for all tables on each node of your cluster. This request is equivalent to executing a SHOW DICTIONARIES ALL
SQL command.
Example:
curl http://myindeximacluster:8082/api/monitor/get/dictionaries \
-H "Authorization: $ACCESS_TOKEN" \
-H "Monitor-Target-Host: indexima-core-1" \
-H "Monitor-Target-Port: 9999" \
--compressed
Reply JSON Format:
Dictionary is represented by a tree structure with the following path :
Name of the node -> Schema -> Table -> Dictionary field or expression
Two structures are sent :
Total memory and lines count, by node
Details for each table on each node
Name | Type | Description |
---|---|---|
size | Integer | The dictionary memory size, in bytes |
count | Integer | The dictionary number of words |
loaded | Boolean | true is this dictionary is currently in memory |