UltraLite C++ User's Guide
  Understanding UltraLite Development

Accessing schema information

Objects in the API represent tables, columns, indexes, and synchronization publications. Each object has a GetSchema method that provides access to information about the structure of that object.

Here is a summary of the information you can access through the schema objects.

• DatabaseSchema    The number and names of the tables in the database, as well as global properties such as the format of dates and times.

  To obtain a DatabaseSchema object, access Connection.GetSchema. See the API Reference in the online books.

• TableSchema    The number and names of the columns and indexes for this table.

  To obtain a TableSchema object, access Table.GetSchema. See the API Reference in the online books.

• IndexSchema    Information about the column in the index. As an index has no data directly associated with it (only the type which is in the columns of the index) there is no separate Index class, just a IndexSchema class.

  To obtain a IndexSchema object, call the TableSchema.GetIndex, the TableSchema.GetOptimalIndex, or the TableSchema.GetPrimaryKey method. See the API Reference in the online books.

• PublicationSchema    Tables and columns contained in a publication. Publications are also comprised of schema only, and so there is only a PublicationSchema object and not a Publication object.

  To obtain a PublicationSchema object, call the DatabaseSchema.TableSchema.GetPublicationSchema method. See the API Reference in the online books.

You cannot modify the schema through the API. You can only retrieve information about the schema.