4.5 Organize Objects into Groups
Groups enable you to organize related database objects under a shared name.
A group is metadata managed by the AI Enrichment package. It does not create, modify, or delete database objects. Instead, a group provides a logical association between multiple database objects, allowing users to organize related objects based on a common area, business meaning, or other user-defined criteria.
For example, a group named MATCH_ANALYTICS could contain tables such as MATCHES, PLAYERS, SHOTS, and PASSES.
4.5.1 Create a Group
Use this command to create a new group.
Syntax
annotation add-group -group <group-name>
[-debug] [-verbose]
Example
annotation add-group -group MATCH_ANALYTICS
This creates a group named MATCH_ANALYTICS.
4.5.2 List Groups
Use this command to list the groups that have been created.
Syntax
annotation list-groups
This lists the available annotation groups.
4.5.3 Add an Object to a Group
Use this command to add a database object to a group.
Syntax
annotation add-to-group -group <group-name>
-type <object-type> -name <object-name>For descriptions of all options, see ANNOTATION.
Example
annotation add-to-group -group MATCH_ANALYTICS
-type TABLE -name SHOTS
This adds the SHOTS table to the MATCH_ANALYTICS group.
4.5.4 Remove an Object from a Group
Use this command to remove an object from a group.
Syntax
annotation remove-from-group -group <group-name>
-type <object-type> -name <object-name>
[-debug] [-verbose]Example
annotation remove-from-group -group MATCH_ANALYTICS
-type TABLE -name SHOTS
This removes the SHOTS table from the MATCH_ANALYTICS group. Note that the SHOTS table is not changed.
4.5.5 Delete a Group
Use this command to delete a group.
Syntax
annotation delete-group -group <group-name>
[-debug] [-verbose]Example
annotation delete-group -group MATCH_ANALYTICSThis example deletes the MATCH_ANALYTICS group metadata. It does not delete the database objects that were in the group, and it does not delete annotations from those objects.