database

Documentation

Overview

Package database implements the go-fed/activity/Database interface.

Index

• type Database
  • func New(db *gorm.DB) *Database
  • func (d *Database) ActorForInbox(c context.Context, inboxIRI *url.URL) (actorIRI *url.URL, err error)
  • func (d *Database) ActorForOutbox(c context.Context, outboxIRI *url.URL) (actorIRI *url.URL, err error)
  • func (d *Database) Create(c context.Context, asType vocab.Type) error
  • func (d *Database) Delete(c context.Context, id *url.URL) error
  • func (d *Database) Exists(c context.Context, id *url.URL) (exists bool, err error)
  • func (d *Database) Followers(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error)
  • func (d *Database) Following(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error)
  • func (d *Database) Get(c context.Context, id *url.URL) (value vocab.Type, err error)
  • func (d *Database) GetInbox(c context.Context, inboxIRI *url.URL) (inbox vocab.ActivityStreamsOrderedCollectionPage, err error)
  • func (d *Database) GetOutbox(c context.Context, inboxIRI *url.URL) (inbox vocab.ActivityStreamsOrderedCollectionPage, err error)
  • func (d *Database) InboxContains(c context.Context, inbox, id *url.URL) (contains bool, err error)
  • func (d *Database) Liked(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error)
  • func (d *Database) Lock(c context.Context, id *url.URL) error
  • func (d *Database) NewId(c context.Context, t vocab.Type) (id *url.URL, err error)
  • func (d *Database) OutboxForInbox(c context.Context, inboxIRI *url.URL) (outboxIRI *url.URL, err error)
  • func (d *Database) Owns(c context.Context, id *url.URL) (owns bool, err error)
  • func (d *Database) SetInbox(c context.Context, inbox vocab.ActivityStreamsOrderedCollectionPage) error
  • func (d *Database) SetOutbox(c context.Context, inbox vocab.ActivityStreamsOrderedCollectionPage) error
  • func (d *Database) Unlock(c context.Context, id *url.URL) error
  • func (d *Database) Update(c context.Context, asType vocab.Type) error

Types

type Database

type Database struct {
	DB *gorm.DB
	// contains filtered or unexported fields
}

A Database is a connection to a database. It uses the gorm connection, so that we can still use the models.

func New

func New(db *gorm.DB) *Database

New returns a new database object.

func (*Database) ActorForInbox

func (d *Database) ActorForInbox(c context.Context, inboxIRI *url.URL) (actorIRI *url.URL, err error)

ActorForInbox fetches the actor's IRI for the given outbox IRI.

The library makes this call only after acquiring a lock first.

func (*Database) ActorForOutbox

func (d *Database) ActorForOutbox(c context.Context, outboxIRI *url.URL) (actorIRI *url.URL, err error)

ActorForOutbox fetches the actor's IRI for the given outbox IRI.

The library makes this call only after acquiring a lock first.

func (*Database) Create

func (d *Database) Create(c context.Context, asType vocab.Type) error

Create adds a new entry to the database which must be able to be keyed by its id.

Note that Activity values received from federated peers may also be created in the database this way if the Federating Protocol is enabled. The client may freely decide to store only the id instead of the entire value.

The library makes this call only after acquiring a lock first.

Under certain conditions and network activities, Create may be called multiple times for the same ActivityStreams object.

func (*Database) Delete

func (d *Database) Delete(c context.Context, id *url.URL) error

Delete removes the entry with the given id.

Delete is only called for federated objects. Deletes from the Social Protocol instead call Update to create a Tombstone.

The library makes this call only after acquiring a lock first.

func (*Database) Exists

func (d *Database) Exists(c context.Context, id *url.URL) (exists bool, err error)

Exists returns true if the database has an entry for the specified id. It may not be owned by this application instance.

The library makes this call only after acquiring a lock first.

func (*Database) Followers

func (d *Database) Followers(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error)

Followers obtains the Followers Collection for an actor with the given id.

If modified, the library will then call Update.

The library makes this call only after acquiring a lock first.

func (*Database) Following

func (d *Database) Following(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error)

Following obtains the Following Collection for an actor with the given id.

If modified, the library will then call Update.

The library makes this call only after acquiring a lock first.

func (*Database) Get

func (d *Database) Get(c context.Context, id *url.URL) (value vocab.Type, err error)

Get returns the database entry for the specified id.

The library makes this call only after acquiring a lock first.

func (*Database) GetInbox

func (d *Database) GetInbox(c context.Context, inboxIRI *url.URL) (inbox vocab.ActivityStreamsOrderedCollectionPage, err error)

GetInbox returns the first ordered collection page of the outbox at the specified IRI, for prepending new items.

The library makes this call only after acquiring a lock first.

func (*Database) GetOutbox

func (d *Database) GetOutbox(c context.Context, inboxIRI *url.URL) (inbox vocab.ActivityStreamsOrderedCollectionPage, err error)

GetOutbox returns the first ordered collection page of the outbox at the specified IRI, for prepending new items.

The library makes this call only after acquiring a lock first.

func (*Database) InboxContains

func (d *Database) InboxContains(c context.Context, inbox, id *url.URL) (contains bool, err error)

InboxContains returns true if the OrderedCollection at 'inbox' contains the specified 'id'.

The library makes this call only after acquiring a lock first.

func (*Database) Liked

func (d *Database) Liked(c context.Context, actorIRI *url.URL) (followers vocab.ActivityStreamsCollection, err error)

Liked obtains the Liked Collection for an actor with the given id.

If modified, the library will then call Update.

The library makes this call only after acquiring a lock first.

func (*Database) Lock

func (d *Database) Lock(c context.Context, id *url.URL) error

Lock takes a lock for the object at the specified id. If an error is returned, the lock must not have been taken.

The lock must be able to succeed for an id that does not exist in the database. This means acquiring the lock does not guarantee the entry exists in the database.

Locks are encouraged to be lightweight and in the Go layer, as some processes require tight loops acquiring and releasing locks.

Used to ensure race conditions in multiple requests do not occur.

func (*Database) NewId

func (d *Database) NewId(c context.Context, t vocab.Type) (id *url.URL, err error)

NewId creates a new IRI id for the provided activity or object. The implementation does not need to set the 'id' property and simply needs to determine the value.

The go-fed library will handle setting the 'id' property on the activity or object provided with the value returned.

func (*Database) OutboxForInbox

func (d *Database) OutboxForInbox(c context.Context, inboxIRI *url.URL) (outboxIRI *url.URL, err error)

OutboxForInbox fetches the corresponding actor's outbox IRI for the actor's inbox IRI.

The library makes this call only after acquiring a lock first.

func (*Database) Owns

func (d *Database) Owns(c context.Context, id *url.URL) (owns bool, err error)

Owns returns true if the database has an entry for the IRI and it exists in the database.

The library makes this call only after acquiring a lock first.

func (*Database) SetInbox

func (d *Database) SetInbox(c context.Context, inbox vocab.ActivityStreamsOrderedCollectionPage) error

SetInbox saves the inbox value given from GetInbox, with new items prepended. Note that the new items must not be added as independent database entries. Separate calls to Create will do that.

The library makes this call only after acquiring a lock first.

func (*Database) SetOutbox

func (d *Database) SetOutbox(c context.Context, inbox vocab.ActivityStreamsOrderedCollectionPage) error

SetOutbox saves the outbox value given from GetOutbox, with new items prepended. Note that the new items must not be added as independent database entries. Separate calls to Create will do that.

The library makes this call only after acquiring a lock first.

func (*Database) Unlock

func (d *Database) Unlock(c context.Context, id *url.URL) error

Unlock makes the lock for the object at the specified id available. If an error is returned, the lock must have still been freed.

Used to ensure race conditions in multiple requests do not occur.

func (*Database) Update

func (d *Database) Update(c context.Context, asType vocab.Type) error

Update sets an existing entry to the database based on the value's id.

Note that Activity values received from federated peers may also be updated in the database this way if the Federating Protocol is enabled. The client may freely decide to store only the id instead of the entire value.

The library makes this call only after acquiring a lock first.