doc

Documentation

Overview

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Index

• type Config
  • func NewConfig(storeURL, db string) *Config
  • func (c *Config) WithDatabse(db string) *Config
  • func (c *Config) WithStoreURL(url string) *Config
• type FileStoreClient
  • func NewFileStoreClient(cfg *Config) *FileStoreClient
  • func (f *FileStoreClient) Count(ctx context.Context, coll string, filter any) (int64, error)
  • func (f *FileStoreClient) Delete(ctx context.Context, coll string, filter any) (int64, error)
  • func (f *FileStoreClient) Find(ctx context.Context, coll string, filter any, results any) error
  • func (f *FileStoreClient) FindWithOpts(ctx context.Context, coll string, filter any, results any, opts *FindOptions) error
  • func (f *FileStoreClient) Insert(ctx context.Context, coll string, docs ...any) (any, error)
  • func (f *FileStoreClient) Update(ctx context.Context, coll string, filter any, update any) (int64, error)
• type FindOptions
• type MongoStoreClient
  • func NewMongoStoreClient(cfg *Config) (*MongoStoreClient, error)
  • func (m *MongoStoreClient) Count(ctx context.Context, coll string, filter interface{}) (int64, error)
  • func (m *MongoStoreClient) Delete(ctx context.Context, coll string, filter interface{}) (int64, error)
  • func (m *MongoStoreClient) Find(ctx context.Context, coll string, filter interface{}, results interface{}) error
  • func (m *MongoStoreClient) FindWithOpts(ctx context.Context, coll string, filter interface{}, results interface{}, ...) error
  • func (m *MongoStoreClient) Insert(ctx context.Context, coll string, docs ...interface{}) (interface{}, error)
  • func (m *MongoStoreClient) Update(ctx context.Context, coll string, filter interface{}, update interface{}) (int64, error)
• type Storer

Types

type Config

type Config struct {
	StoreURL string // used such as a MongoDB connection string (example: mongodb+srv://.../dbName)
	Database string // which database to connect to
}

Config holds configuration details for connecting to a document database.

func NewConfig

func NewConfig(storeURL, db string) *Config

func (*Config) WithDatabse

func (c *Config) WithDatabse(db string) *Config

WithDatabse sets a new document databse and returns the updated Config.

func (*Config) WithStoreURL

func (c *Config) WithStoreURL(url string) *Config

WithStoreURL sets a new document store URL and returns the updated Config.

type FileStoreClient

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

func NewFileStoreClient

func NewFileStoreClient(cfg *Config) *FileStoreClient

func (*FileStoreClient) Count

func (f *FileStoreClient) Count(
	ctx context.Context,
	coll string,
	filter any,
) (int64, error)

func (*FileStoreClient) Delete

func (f *FileStoreClient) Delete(
	ctx context.Context,
	coll string,
	filter any,
) (int64, error)

func (*FileStoreClient) Find

func (f *FileStoreClient) Find(
	ctx context.Context,
	coll string,
	filter any,
	results any,
) error

func (*FileStoreClient) FindWithOpts

func (f *FileStoreClient) FindWithOpts(
	ctx context.Context,
	coll string,
	filter any,
	results any,
	opts *FindOptions,
) error

func (*FileStoreClient) Insert

func (f *FileStoreClient) Insert(
	ctx context.Context,
	coll string,
	docs ...any,
) (any, error)

func (*FileStoreClient) Update

func (f *FileStoreClient) Update(
	ctx context.Context,
	coll string,
	filter any,
	update any,
) (int64, error)

type FindOptions

type FindOptions struct {
	Skip  int64
	Limit int64
}

type MongoStoreClient

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

func NewMongoStoreClient

func NewMongoStoreClient(cfg *Config) (*MongoStoreClient, error)

func (*MongoStoreClient) Count

func (m *MongoStoreClient) Count(ctx context.Context, coll string, filter interface{}) (int64, error)

func (*MongoStoreClient) Delete

func (m *MongoStoreClient) Delete(ctx context.Context, coll string, filter interface{}) (int64, error)

func (*MongoStoreClient) Find

func (m *MongoStoreClient) Find(ctx context.Context, coll string, filter interface{}, results interface{}) error

func (*MongoStoreClient) FindWithOpts

func (m *MongoStoreClient) FindWithOpts(
	ctx context.Context,
	coll string,
	filter interface{},
	results interface{},
	o *FindOptions,
) error

func (*MongoStoreClient) Insert

func (m *MongoStoreClient) Insert(ctx context.Context, coll string, docs ...interface{}) (interface{}, error)

func (*MongoStoreClient) Update

func (m *MongoStoreClient) Update(ctx context.Context, coll string, filter interface{}, update interface{}) (int64, error)

type Storer

type Storer interface {
	Insert(ctx context.Context, coll string, docs ...interface{}) (interface{}, error)
	Update(ctx context.Context, coll string, filter interface{}, update interface{}) (int64, error)
	Delete(ctx context.Context, coll string, filter interface{}) (int64, error)

	Find(ctx context.Context, coll string, filter interface{}, results interface{}) error
	FindWithOpts(ctx context.Context, coll string, filter interface{}, results interface{}, opts *FindOptions) error
	Count(ctx context.Context, coll string, filter interface{}) (int64, error)
}