Skip to content
This page View Markdown Open in ChatGPT Open in Claude

Get table meta

g.sys.system.getTableMeta calls the get table meta system API from your code, whatever the settings of that API say about HTTP callers.

Get table metadata System API

Get table metadata using global object 'g'.

1
2
3
4
5
await g.sys.system.getTableMeta({
    instance: 'INSTANCE_NAME',
    database: 'DATABASE_NAME',
    collection: 'COLLECTION_NAME'
});

Multi-tenant

  • instance: "crm::acme" reads the table in the database of the tenant acme of the multi-tenant instance crm. In a custom API called for a tenant, instance: "crm" reads it in the database of that tenant.
1
2
3
4
5
await g.sys.system.getTableMeta({
    instance: 'crm::acme',
    database: 'crm',
    collection: 'customers'
});