package
0.0.0-20240513174111-a311b3bdd62a
Repository: https://github.com/aptrust/registry.git
Documentation: pkg.go.dev
# Functions
AlertByID returns the alert with the specified id.
AlertGet returns the first alert matching the query.
AlertSelect returns all alerts matching the query.
AlertViewForUser returns the alert with the specified ID for the specified recipient (user id).
AlertViewGet returns the first alert matching the query.
AlertViewSelect returns all alerts matching the query.
No description provided by the author
No description provided by the author
No description provided by the author
ChecksumByID returns the file with the specified id.
ChecksumGet returns the first file matching the query.
ChecksumSelect returns all files matching the query.
ChecksumViewByID returns the file with the specified id.
ChecksumViewGet returns the first file matching the query.
ChecksumViewSelect returns all files matching the query.
CountObjectsThatCanBeDeleted returns the number of active objects in the list of object IDs that belong to the specified institution.
CreateAlert adds customized text to the alert and saves it in the database.
No description provided by the author
No description provided by the author
DeletionRequestByID returns the institution with the specified id.
DeletionRequestGet returns the first deletion request matching the query.
DeletionRequestIncludesFile returns true if the deletion request with the specified ID includes the generic file with the specified ID.
DeletionRequestIncludesObject returns true if the deletion request with the specified ID includes the intellectual object with the specified ID.
DeletionRequestSelect returns all deletion requests matching the query.
DeletionRequestViewByID returns the DeletionRequestView record with the specified id.
DeletionRequestViewGet returns the first user view record matching the query.
DeletionRequestViewSelect returns all DeletionRequestView records matching the query.
DepositFormatStatsSelect returns summary stats on the files belonging to the specified institution and/or object.
No description provided by the author
DepositStatsSelect returns info about materials a depositor updated in our system before a given date.
No description provided by the author
No description provided by the author
No description provided by the author
GenericFileByID returns the file with the specified id.
GenericFileByIdentifier returns the file with the specified identifier.
GenericFileCreateBatch creates a batch of GenericFiles and their dependent records (PremisEvents, Checksums, and StorageRecords) in a single transaction.
GenericFileGet returns the first file matching the query.
GenericFileSelect returns all files matching the query.
GenericFileViewByID returns the GenericFileView record with the specified id.
GenericFileViewByIdentifier returns the GenericFileView record with the specified email address.
GenericFileViewGet returns the first user view record matching the query.
GenericFileViewSelect returns all GenericFileView records matching the query.
GetCountFromView returns a snapshotted count from a materialized view.
GetTestObject returns an IntellectualObject with valid settings that can be altered per-test.
IdForEventIdentifier returns the ID of the PremisEvent having the specified identifier.
IdForFileIdentifier returns the ID of the GenericFile having the specified identifier.
IdForInstIdentifier returns the id of the insitution with the given identifier, or an error if no matching record exists.
IdForFileIdentifier returns the ID of the IntellectualObject having the specified identifier.
No description provided by the author
InstitutionByID returns the institution with the specified id.
InstitutionByIdentifier returns the institution with the specified identifier.
InstitutionGet returns the first institution matching the query.
InstitutionSelect returns all institutions matching the query.
InstitutionViewByID returns the InstitutionView record with the specified id.
InstitutionViewByIdentifier returns the InstitutionView record with the specified identifier (domain name).
InstitutionViewGet returns the first user view record matching the query.
InstitutionViewSelect returns all InstitutionView records matching the query.
IntellectualObjectByID returns the object with the specified id.
IntellectualObjectByIdentifier returns the object with the specified identifier.
IntellectualObjectGet returns the first object matching the query.
IntellectualObjectSelect returns all objects matching the query.
IntellectualObjectViewByID returns the object with the specified id.
IntellectualObjectViewByIdentifier returns the object with the specified identifier.
IntellectualObjectViewGet returns the first object matching the query.
IntellectualObjectViewSelect returns all objects matching the query.
InternalMetadataByKey returns the file with the specified key.
InternalMetadataGet returns the first file matching the query.
InternalMetadataSelect returns all files matching the query.
IsNoRowError returns true if err is pg.ErrNoRows.
LastSuccessfulIngest returns the last successful ingest WorkItem for the specified intellectual object id.
NewDeletionItem creates a new work item to delete a file or object.
No description provided by the author
NewFilterCollection returns a ParamFileters object.
NewInternalMetadata creates a new InternalMetadata record.
NewItemFromLastSuccessfulIngest creates a new WorkItem based on the last successful ingest WorkItem of the specified object.
NewParamFilter returns a new ParamFilter object based on the key and values submitted in the query string.
No description provided by the author
NewRestorationItem creates and saves a new WorkItem for an object or file restoration.
NewSortParam creates a new sort parameter to add to a query.
ObjectEventCount returns the number of object-level PremisEvents for the specified IntellectualObject.
ObjectFileCount returns the number of active files with the specified Intellectial Object ID.
Object files returns files belonging to an intellectual object.
No description provided by the author
PremisEventByID returns the event with the specified id.
PremisEventByIdentifier returns the event with the specified identifier.
PremisEventGet returns the first event matching the query.
PremisEventSelect returns all events matching the query.
PremisEventViewByID returns the event with the specified id.
PremisEventViewByIdentifier returns the event with the specified identifier.
PremisEventViewGet returns the first event matching the query.
PremisEventViewSelect returns all events matching the query.
RandomChecksum returns a random checksum with the specified algorithm.
RandFileBatch returns a slice of 20 GenericFiles, each with 4 events, checksums, and storage records.
RandomGenericFile returns a random generic file with the specified obj identifier prefix.
No description provided by the author
RandomPremisEvent returns a random premis event of the specified type.
RandomStorageRecord() returns a random storage record.
No description provided by the author
SchemaMigrationSelect returns all records matching the query.
SmallestObjectNotRestoredInXDays returns the smallest intellectual object belonging to an institutition that has not been restored in at least X days.
StatsByFormat returns the stats for the specified format, or nil if not found.
StorageOptionByID returns the option with the specified id.
No description provided by the author
StorageOptionGet returns the first option matching the query.
No description provided by the author
StorageOptionSelect returns all options matching the query.
StorageRecordByID returns the file with the specified id.
StorageRecordGet returns the first file matching the query.
StorageRecordSelect returns all files matching the query.
No description provided by the author
UserByEmail returns the user with the specified email address.
UserByID returns the institution with the specified id.
UserGet returns the first user matching the query.
UserSelect returns all user matching the query.
UserSignIn signs a user in.
UserViewByEmail returns the UserView record with the specified email address.
UserViewByID returns the UserView record with the specified id.
UserViewGet returns the first user view record matching the query.
UserViewSelect returns all UserView records matching the query.
WorkItemByID returns the work item with the specified id.
WorkItemGet returns the first work item matching the query.
WorkItemSelect returns all work items matching the query.
WorkItemsPendingForFile returns a list of in-progress WorkItems for the GenericFile with the specified ID.
WorkItemsPendingForObject returns a list of in-progress WorkItems for the IntellectualObject with the specified institution ID and bag name.
WorkItemsPendingForObjectBatch returns the number of WorkItems pending.
WorkItemViewByID returns the work item with the specified id.
WorkItemViewGet returns the first work item matching the query.
WorkItemViewSelect returns all work items matching the query.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
Note: chart_metric and report_type are ignored by backend.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IntellectualObjectFilters describes the allowed filters for searching IntellectualObjects.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DeletionRequestMin includes the subset of DeletionRequest info that we want to expose through the member API.
No description provided by the author
No description provided by the author
DeletionRequestsView contains a flattened view of deletion requests suitable for the index page.
No description provided by the author
DepositStats contains info about member deposits and the costs of those deposits.
FilterCollection converts query string params such as name__eq=Homer to a pgmodels.Query object that allows us to build a SQL where clause as we go.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InstitutionView contains information about an institution and its parent (if it has one).
No description provided by the author
No description provided by the author
No description provided by the author
InternalMetadata contains metadata about the state of the database.
ParamFilter parses query string params into filters that can be added to a SQL where clause.
No description provided by the author
No description provided by the author
No description provided by the author
Query provides a fluent model for constructing SQL queries, though it currently constructs only the where, order by, limit and offset clauses, which is all we need to pass to the go-pg adapter.
SchemaMigration represents a schema migration record from the database.
No description provided by the author
StorageOption contains information about APTrust storage option costs.
No description provided by the author
No description provided by the author
User is a person who can log in and do stuff.
UserMin contains minimum required information to identify a user.
No description provided by the author
WorkItem contains information about a task or suite of related tasks to be performed by the preservation services workers, such as ingest, restoration, and deletion.
No description provided by the author
WorkItemView is a read-only model for querying.
# Interfaces
No description provided by the author