# Package com.io7m.cardant.database.api

@Version("1.0.0") @Export package com.io7m.cardant.database.api
Inventory system (Database API).

- Class
  Description
  CADatabaseAuditSearchType
  The type of audit event searches.
  CADatabaseConfiguration
  The server database configuration.
  CADatabaseConnectionType
  The type of database connections.
  CADatabaseCreate
  Create or do not create a database.
  CADatabaseEventType
  The type of model database events.
  CADatabaseEventUpdated
  Data in the model database was updated.
  CADatabaseException
  The type of exceptions raised by the server database.
  CADatabaseFactoryType
  The type of server database factories.
  CADatabaseFileSearchType
  The type of file searches.
  CADatabaseIncludeRedacted
  Whether to include redacted items.
  CADatabaseItemSearchType
  The type of item searches.
  CADatabasePagedQueryType<T>
  The type of paged queries.
  CADatabaseQueriesAuditType
  The database queries involving the audit log.
  CADatabaseQueriesAuditType.EventAddType
  Add an audit event.
  CADatabaseQueriesAuditType.EventSearchType
  Search for audit events.
  CADatabaseQueriesFilesType
  Model database queries (Files).
  CADatabaseQueriesFilesType.GetType
  Get the given file.
  CADatabaseQueriesFilesType.GetType.Parameters
  Parameters for retrieving a file.
  CADatabaseQueriesFilesType.PutType
  Create or update the given file.
  CADatabaseQueriesFilesType.RemoveType
  Remove the given file.
  CADatabaseQueriesFilesType.SearchType
  Search for files.
  CADatabaseQueriesItemsType
  Model database queries (Items).
  CADatabaseQueriesItemsType.AttachmentAddType
  Add an attachment to the given item.
  CADatabaseQueriesItemsType.AttachmentAddType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.AttachmentRemoveType
  Remove an attachment from the given item.
  CADatabaseQueriesItemsType.AttachmentRemoveType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.CreateType
  Create an item with the given ID.
  CADatabaseQueriesItemsType.DeleteMarkOnlyType
  Mark the given items as deleted.
  CADatabaseQueriesItemsType.DeleteType
  Delete the given items.
  CADatabaseQueriesItemsType.GetType
  Retrieve the item with the given ID, if one exists.
  CADatabaseQueriesItemsType.LocationsType
  Retrieve the locations of the given item.
  CADatabaseQueriesItemsType.MetadataPutType
  Add or update metadata on an item.
  CADatabaseQueriesItemsType.MetadataPutType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.MetadataRemoveType
  Remove metadata from an item.
  CADatabaseQueriesItemsType.MetadataRemoveType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.RepositType
  Reposit items.
  CADatabaseQueriesItemsType.SearchType
  Start searching for items.
  CADatabaseQueriesItemsType.SetNameType
  Set the name for the given item.
  CADatabaseQueriesItemsType.SetNameType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.TypesAssignType
  Assign types to the given item.
  CADatabaseQueriesItemsType.TypesAssignType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.TypesRevokeType
  Revoke types from the given item.
  CADatabaseQueriesItemsType.TypesRevokeType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType
  Model database queries (Locations).
  CADatabaseQueriesLocationsType.AttachmentAddType
  Add an attachment to the given location.
  CADatabaseQueriesLocationsType.AttachmentAddType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.AttachmentRemoveType
  Remove an attachment from the given location.
  CADatabaseQueriesLocationsType.AttachmentRemoveType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.GetType
  Retrieve a location.
  CADatabaseQueriesLocationsType.ListType
  List locations.
  CADatabaseQueriesLocationsType.MetadataPutType
  Add or update metadata on a location.
  CADatabaseQueriesLocationsType.MetadataPutType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.MetadataRemoveType
  Remove metadata from a location.
  CADatabaseQueriesLocationsType.MetadataRemoveType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.PutType
  Create or update the given location.
  CADatabaseQueriesLocationsType.TypesAssignType
  Assign types to the given location.
  CADatabaseQueriesLocationsType.TypesAssignType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.TypesRevokeType
  Revoke types from the given location.
  CADatabaseQueriesLocationsType.TypesRevokeType.Parameters
  Parameters for the operation.
  CADatabaseQueriesMaintenanceType
  The database queries involving maintenance.
  CADatabaseQueriesMaintenanceType.ExecuteType
  Execute maintenance queries.
  CADatabaseQueriesType
  The base type of query interfaces.
  CADatabaseQueriesTypesType
  Model database queries (Types).
  CADatabaseQueriesTypesType.TypeDeclarationGetMultipleType
  Get multiple type declarations.
  CADatabaseQueriesTypesType.TypeDeclarationGetType
  Get a type declaration.
  CADatabaseQueriesTypesType.TypeDeclarationPutType
  Create or update a type declaration.
  CADatabaseQueriesTypesType.TypeDeclarationRemoveType
  Remove a type declaration.
  CADatabaseQueriesTypesType.TypeDeclarationsReferencingScalarType
  Search for type declarations that reference the scalar type with the given name.
  CADatabaseQueriesTypesType.TypeDeclarationsSearchType
  Search for type declarations.
  CADatabaseQueriesTypesType.TypeScalarGetType
  Get a scalar type declaration.
  CADatabaseQueriesTypesType.TypeScalarPutType
  Create or update a scalar type declaration.
  CADatabaseQueriesTypesType.TypeScalarRemoveType
  Remove a scalar type declaration.
  CADatabaseQueriesTypesType.TypeScalarSearchType
  Search for scalar type declarations.
  CADatabaseQueriesUsersType
  The database queries involving users.
  CADatabaseQueriesUsersType.GetType
  Retrieve a user.
  CADatabaseQueriesUsersType.PutType
  Update the given user.
  CADatabaseQueryType<P,R>
  The base type of queries that accept parameters and produce results.
  CADatabaseRole
  The roles used by the server database.
  CADatabaseTelemetry
  Interfaces used for database telemetry.
  CADatabaseTransactionType
  A database transaction.
  CADatabaseType
  An open database.
  CADatabaseTypeDeclarationSearchType
  The type of declared type searches.
  CADatabaseTypeScalarSearchType
  The type of scalar type searches.
  CADatabaseUnit
  The unit type.
  CADatabaseUpgrade
  Upgrade or do not upgrade a database.
  CADatabaseUserUpdates
  Functions to update users.