Skip to content

Commit

Permalink
Add documentation on column groups
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyMcCormick committed Jan 16, 2025
1 parent f73d6b6 commit 3833e90
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/user-guide/model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,18 @@ A column may also have the following optional properties:
.. [2] `TAP Access Protocol (TAP) specification <https://www.ivoa.net/documents/TAP/>`__
.. [3] `VOTable specification <http://www.ivoa.net/documents/VOTable/>`__
*************
Column Groups
*************

A `column group <../dev/internals/felis.datamodel.Schema.html#felis.datamodel.ColumnGroup>`__ represents a set of related columns in a table.
In addition to the standard column attributes, column groups have the following attributes:

:``ivoa:ucd``: The `IVOA UCD <http://www.ivoa.net/documents/latest/UCD.html>`__ for this column group.
:``columns``: The list of columns in this column group, which should be IDs of columns in the table. This is a required field.

The functionality of column groups is currently limited but may be expanded in future versions of Felis, in particular to support VOTable ``GROUP`` elements.

.. _Constraint:

**********
Expand Down

0 comments on commit 3833e90

Please sign in to comment.