database

Documentation

Overview

Package database provides a client for interacting with the database.

Index

• Constants
• func Close(ctx context.Context, m *Client) error
• type Client
  • func Dial(ctx context.Context, uri ...string) (*Client, error)
  • func (m *Client) AddUserToTeam(ctx context.Context, id string, userId string) error
  • func (m *Client) BulkCreateResources(ctx context.Context, resources []*models.Resource) error
  • func (m *Client) CreateResource(ctx context.Context, resource *models.Resource) error
  • func (m *Client) CreateTeam(ctx context.Context, team *models.Team) error
  • func (m *Client) CreateUser(ctx context.Context, user *models.User) error
  • func (m *Client) DeleteOneResource(ctx context.Context, id string) error
  • func (m *Client) DeleteTeam(ctx context.Context, id string) error
  • func (m *Client) DeleteUser(ctx context.Context, id string) error
  • func (m *Client) FindAllResourcesByTeamId(ctx context.Context, teamId string) ([]*models.Resource, error)
  • func (m *Client) FindMultipleResources(ctx context.Context, teamId primitive.ObjectID, filters []models.Filter) ([]*models.Resource, error)
  • func (m *Client) FindOneResource(ctx context.Context, id string) (*models.Resource, error)
  • func (m *Client) FindTeam(ctx context.Context, id string) (*models.Team, error)
  • func (m *Client) FindTeams(ctx context.Context) ([]*models.Team, error)
  • func (m *Client) FindUser(ctx context.Context, id string) (*models.User, error)
  • func (m *Client) FindUserByUsername(ctx context.Context, username string) (*models.User, error)
  • func (m *Client) FindUsersByTeamId(ctx context.Context, teamId string) ([]*models.User, error)
  • func (m *Client) UpdateOneResource(ctx context.Context, id string, resource *models.Resource) (*primitive.ObjectID, error)
  • func (m *Client) UpdateTeam(ctx context.Context, id string, team *models.Team) (*primitive.ObjectID, error)
  • func (m *Client) UpdateUser(ctx context.Context, id string, user *models.User) (*primitive.ObjectID, error)

Constants

const (
	// AeroSquirrelDatabase is the name of the database.
	AeroSquirrelDatabase = "aerosquirrel"

	// TeamCollection is the name of the team collection.
	TeamCollection = "teams"
	// UserCollection is the name of the user collection.
	UserCollection = "users"
	// ResourceCollection is the name of the resource collection.
	ResourceCollection = "resources"
)

Functions

func Close

func Close(ctx context.Context, m *Client) error

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a client for interacting with the database.

func Dial

func Dial(ctx context.Context, uri ...string) (*Client, error)

Dial dials the database.

func (*Client) AddUserToTeam

func (m *Client) AddUserToTeam(ctx context.Context, id string, userId string) error

AddUserToTeam adds a user to a team in the database.

func (*Client) BulkCreateResources

func (m *Client) BulkCreateResources(ctx context.Context, resources []*models.Resource) error

BulkCreateResources creates a resource in the database.

func (*Client) CreateResource

func (m *Client) CreateResource(ctx context.Context, resource *models.Resource) error

CreateResource creates a resource in the database.

func (*Client) CreateTeam

func (m *Client) CreateTeam(ctx context.Context, team *models.Team) error

CreateTeam creates a new team in the database.

func (*Client) CreateUser

func (m *Client) CreateUser(ctx context.Context, user *models.User) error

CreateUser creates a new user in the database.

func (*Client) DeleteOneResource

func (m *Client) DeleteOneResource(ctx context.Context, id string) error

DeleteOneResource deletes a resource in the database.

func (*Client) DeleteTeam

func (m *Client) DeleteTeam(ctx context.Context, id string) error

DeleteTeam deletes a team in the database.

func (*Client) DeleteUser

func (m *Client) DeleteUser(ctx context.Context, id string) error

DeleteUser deletes a user in the database.

func (*Client) FindAllResourcesByTeamId

func (m *Client) FindAllResourcesByTeamId(ctx context.Context, teamId string) ([]*models.Resource, error)

FindAllResourcesByTeamId finds all resources in the database.

func (*Client) FindMultipleResources

func (m *Client) FindMultipleResources(ctx context.Context, teamId primitive.ObjectID, filters []models.Filter) ([]*models.Resource, error)

FindMultipleResources finds multiple resources in the database.

func (*Client) FindOneResource

func (m *Client) FindOneResource(ctx context.Context, id string) (*models.Resource, error)

FindOneResource finds a resource in the database.

func (*Client) FindTeam

func (m *Client) FindTeam(ctx context.Context, id string) (*models.Team, error)

FindTeam finds a team in the database.

func (*Client) FindTeams

func (m *Client) FindTeams(ctx context.Context) ([]*models.Team, error)

FindTeams finds all teams in the database.

func (*Client) FindUser

func (m *Client) FindUser(ctx context.Context, id string) (*models.User, error)

FindUser finds a user in the database.

func (*Client) FindUserByUsername

func (m *Client) FindUserByUsername(ctx context.Context, username string) (*models.User, error)

FindUserByUsername finds a user in the database.

func (*Client) FindUsersByTeamId

func (m *Client) FindUsersByTeamId(ctx context.Context, teamId string) ([]*models.User, error)

FindUsersByTeamId finds all users in the database.

func (*Client) UpdateOneResource

func (m *Client) UpdateOneResource(ctx context.Context, id string, resource *models.Resource) (*primitive.ObjectID, error)

UpdateOneResource updates a resource in the database.

func (*Client) UpdateTeam

func (m *Client) UpdateTeam(ctx context.Context, id string, team *models.Team) (*primitive.ObjectID, error)

UpdateTeam updates a team in the database.

func (*Client) UpdateUser

func (m *Client) UpdateUser(ctx context.Context, id string, user *models.User) (*primitive.ObjectID, error)

UpdateUser updates a user in the database.