Package tigase.db

# Annotation Interface Repository.SchemaId

Enclosing interface:
  Repository

@Retention(RUNTIME) @Target(TYPE) public static @interface Repository.SchemaId
Annotation provides information about schema (ie. database schema) required by annotated class.

- ## Required Element Summary

  Required Elements
  Modifier and Type
  Required Element
  Description
  `String`
  `id`
  Method returns identifiers of a schema (ie. database schema) required by annotated class.
  `String`
  `name`
  Method returns name of a schema required by annotated class. *
  Result of this method is intended to be displayed to the user.

- ## Optional Element Summary

  Optional Elements
  Modifier and Type
  Optional Element
  Description
  `boolean`
  `external`
  Method indicates whether schema definition is stored externally to the class (for example in `.sql` files.

- ## Element Details

  - ### id

    String id
    Method returns identifiers of a schema (ie. database schema) required by annotated class.
    Returns:
      id of a schema

  - ### name

    String name
    Method returns name of a schema required by annotated class. *
    Result of this method is intended to be displayed to the user.
    Returns:
      name of a schema

- - ### external

    boolean external
    Method indicates whether schema definition is stored externally to the class (for example in `.sql` files.
    Returns:
      true if the schema definitions are stored in `.sql` files.
    Default:
      true