mongo

package

v0.7.0 Latest Latest Go to latest Published: Nov 16, 2021 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ONSdigital/dp-permissions-api

Links

Open Source Insights

Documentation ¶

Index ¶

type Mongo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Mongo ¶

type Mongo struct {
	Database           string
	RolesCollection    string
	PoliciesCollection string
	Connection         *dpMongodb.MongoConnection
	// contains filtered or unexported fields
}

Mongo represents a simplistic MongoDB configuration, with session and health client

func (*Mongo) AddPolicy ¶ added in v0.5.0

func (m *Mongo) AddPolicy(ctx context.Context, policy *models.Policy) (*models.Policy, error)

AddPolicy inserts new policy to data store

func (*Mongo) Checker ¶

func (m *Mongo) Checker(ctx context.Context, state *healthcheck.CheckState) error

Checker is called by the healthcheck library to check the health state of this mongoDB instance

func (*Mongo) Close ¶

func (m *Mongo) Close(ctx context.Context) error

Close closes the mongo session and returns any error

func (*Mongo) GetAllBundlePolicies ¶ added in v0.5.0

func (m *Mongo) GetAllBundlePolicies(ctx context.Context) ([]*models.BundlePolicy, error)

GetAllBundlePolicies returns all policy documents for a permissions bundle, without pagination

func (*Mongo) GetAllRoles ¶ added in v0.5.0

func (m *Mongo) GetAllRoles(ctx context.Context) ([]*models.Role, error)

GetAllRoles returns all role documents, without pagination

func (*Mongo) GetPolicy ¶ added in v0.5.0

func (m *Mongo) GetPolicy(ctx context.Context, id string) (*models.Policy, error)

func (*Mongo) GetRole ¶ added in v0.3.0

func (m *Mongo) GetRole(ctx context.Context, id string) (*models.Role, error)

GetRole retrieves a role document by its ID

func (*Mongo) GetRoles ¶ added in v0.4.0

func (m *Mongo) GetRoles(ctx context.Context, offset, limit int) (*models.Roles, error)

GetRoles retrieves all role documents from Mongo, according to the provided limit and offset. Offset and limit need to be positive or zero. Zero limit is equivalent to no limit and all items starting at the offset will be returned.

func (*Mongo) Init ¶

func (m *Mongo) Init(mongoConf config.MongoDB) error

Init creates a new mongoConnection with a strong consistency and a write mode of "majority"

Source Files ¶

View all Source files

mongo.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL