# 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.
  CADatabaseLanguage
  A database language name.
  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.ItemAttachmentAddType
  Add an attachment to the given item.
  CADatabaseQueriesItemsType.ItemAttachmentAddType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.ItemAttachmentRemoveType
  Remove an attachment from the given item.
  CADatabaseQueriesItemsType.ItemAttachmentRemoveType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.ItemCreateType
  Create an item with the given ID.
  CADatabaseQueriesItemsType.ItemDeleteMarkOnlyType
  Mark the given items as deleted/undeleted.
  CADatabaseQueriesItemsType.ItemDeleteMarkOnlyType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.ItemDeleteType
  Delete the given items.
  CADatabaseQueriesItemsType.ItemGetType
  Retrieve the item with the given ID, if one exists.
  CADatabaseQueriesItemsType.ItemMetadataPutType
  Add or update metadata on an item.
  CADatabaseQueriesItemsType.ItemMetadataPutType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.ItemMetadataRemoveType
  Remove metadata from an item.
  CADatabaseQueriesItemsType.ItemMetadataRemoveType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.ItemSearchType
  Start searching for items.
  CADatabaseQueriesItemsType.ItemSetNameType
  Set the name for the given item.
  CADatabaseQueriesItemsType.ItemSetNameType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.ItemTypesAssignType
  Assign types to the given item.
  CADatabaseQueriesItemsType.ItemTypesAssignType.Parameters
  Parameters for the operation.
  CADatabaseQueriesItemsType.ItemTypesRevokeType
  Revoke types from the given item.
  CADatabaseQueriesItemsType.ItemTypesRevokeType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType
  Model database queries (Locations).
  CADatabaseQueriesLocationsType.LocationAttachmentAddType
  Add an attachment to the given location.
  CADatabaseQueriesLocationsType.LocationAttachmentAddType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.LocationAttachmentRemoveType
  Remove an attachment from the given location.
  CADatabaseQueriesLocationsType.LocationAttachmentRemoveType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.LocationDeleteMarkOnlyType
  Mark the given locations as deleted/undeleted.
  CADatabaseQueriesLocationsType.LocationDeleteMarkOnlyType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.LocationDeleteType
  Delete the given locations.
  CADatabaseQueriesLocationsType.LocationGetType
  Retrieve a location.
  CADatabaseQueriesLocationsType.LocationListType
  List locations.
  CADatabaseQueriesLocationsType.LocationListType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.LocationMetadataPutType
  Add or update metadata on a location.
  CADatabaseQueriesLocationsType.LocationMetadataPutType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.LocationMetadataRemoveType
  Remove metadata from a location.
  CADatabaseQueriesLocationsType.LocationMetadataRemoveType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.LocationPutType
  Create or update the given location.
  CADatabaseQueriesLocationsType.LocationTypesAssignType
  Assign types to the given location.
  CADatabaseQueriesLocationsType.LocationTypesAssignType.Parameters
  Parameters for the operation.
  CADatabaseQueriesLocationsType.LocationTypesRevokeType
  Revoke types from the given location.
  CADatabaseQueriesLocationsType.LocationTypesRevokeType.Parameters
  Parameters for the operation.
  CADatabaseQueriesMaintenanceType
  The database queries involving maintenance.
  CADatabaseQueriesMaintenanceType.ExecuteType
  Execute maintenance queries.
  CADatabaseQueriesStockType
  Model database queries (Stock).
  CADatabaseQueriesStockType.StockCountType
  Count stock.
  CADatabaseQueriesStockType.StockGetType
  Retrieve stock.
  CADatabaseQueriesStockType.StockRepositType
  Reposit stock.
  CADatabaseQueriesStockType.StockSearchType
  Search for stock.
  CADatabaseQueriesType
  The base type of query interfaces.
  CADatabaseQueriesTypePackagesType
  Model database queries (Type packages).
  CADatabaseQueriesTypePackagesType.TypePackageGetTextType
  Get the text of a type package.
  CADatabaseQueriesTypePackagesType.TypePackageInstallType
  Install a type package.
  CADatabaseQueriesTypePackagesType.TypePackageSatisfyingType
  Find a package satisfying the given name and version range.
  CADatabaseQueriesTypePackagesType.TypePackageSatisfyingType.Parameters
  The parameters.
  CADatabaseQueriesTypePackagesType.TypePackageSearchType
  Start searching for type packages.
  CADatabaseQueriesTypePackagesType.TypePackageUninstallType
  Uninstall a type package.
  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.
  CADatabaseStockSearchType
  The type of stock searches.
  CADatabaseTelemetry
  Interfaces used for database telemetry.
  CADatabaseTransactionType
  A database transaction.
  CADatabaseType
  An open database.
  CADatabaseTypePackageResolver
  A database type package resolver.
  CADatabaseTypePackageSearchType
  The type of type package searches.
  CADatabaseTypeRecordSearchType
  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.