Skip to Content

getInfo(lang?: string): Promise<TableInfo>

Retrieves the table/view info

Parameters

  • lang optional string

    Language code for i18n data. “en” by default

Return type

TableInfo

  • oid required number

    OID from the postgres database Useful in handling renamed tables

  • comment optional string

    Comment from the postgres database

  • isFileTable optional FileTableConfig

    Defined if this is the fileTable

    • allowedNestedInserts optional { table: string; column: string; }
  • hasFiles optional boolean

    True if fileTable is enabled and this table references the fileTable Used in UI

  • isView optional boolean

    True if this is a view. Table methods (insert, update, delete) are undefined for views

  • fileTableName optional string

    Name of the fileTable (if enabled) Used in UI

  • dynamicRules optional { update?: boolean | undefined; }

    • update optional boolean
  • label optional string

    Additional table info provided through TableConfig

  • uniqueColumnGroups optional string

  • publishInfo required { select?: { disabledMethods?: Partial<Record<“findOne” | “find” | “count” | “size” | “subscribe” | “subscribeOne” | “sync”, 1>> | undefined; syncConfig: SyncTableInfo | undefined; } | undefined; update?: { …; } | undefined; insert?: { …; } | undefined; delete?: {} | undefined; }

    • select optional { disabledMethods?: Partial<Record<“findOne” | “find” | “count” | “size” | “subscribe” | “subscribeOne” | “sync”, 1>> | undefined; syncConfig: SyncTableInfo | undefined; }
      • disabledMethods optional Partial
      • syncConfig required SyncTableInfo | undefined
    • update optional { disabledMethods?: Partial<Record<“update” | “upsert” | “updateBatch”, 1>> | undefined; }
      • disabledMethods optional Partial
    • insert optional { requiredNestedInserts?: RequiredNestedInsert[] | undefined; allowedNestedInserts?: string[] | undefined; }
      • requiredNestedInserts optional RequiredNestedInsert[]

        Controlled through the publish.table_name.insert config If defined then any insert on this table must also contain nested inserts for the specified tables that reference this table

      • allowedNestedInserts optional string

    • delete optional {}
Last updated on