driver

Documentation

Index

• type Driver
  • func NewDirectoryDriver(db *sql.DB, opts ...Options) *Driver
  • func (t *Driver) CreateDirectory(ctx context.Context, d *v1.Directory) (*v1.Directory, error)
  • func (t *Driver) CreateRoot(ctx context.Context, d *v1.Directory) (*v1.Directory, error)
  • func (t *Driver) GetChildren(ctx context.Context, parent v1.DirectoryID) ([]v1.DirectoryID, error)
  • func (t *Driver) GetDirectory(ctx context.Context, id v1.DirectoryID) (*v1.Directory, error)
  • func (t *Driver) GetParents(ctx context.Context, child v1.DirectoryID) ([]v1.DirectoryID, error)
  • func (t *Driver) GetParentsUntilAncestor(ctx context.Context, child, ancestor v1.DirectoryID) ([]v1.DirectoryID, error)
  • func (t *Driver) ListRoots(ctx context.Context) ([]v1.DirectoryID, error)
• type Options
  • func WithFastReads() Options
  • func WithReadOnly() Options

Types

type Driver

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

func NewDirectoryDriver

func NewDirectoryDriver(db *sql.DB, opts ...Options) *Driver

func (*Driver) CreateDirectory

func (t *Driver) CreateDirectory(ctx context.Context, d *v1.Directory) (*v1.Directory, error)

func (*Driver) CreateRoot

func (t *Driver) CreateRoot(ctx context.Context, d *v1.Directory) (*v1.Directory, error)

CreateRoot creates a root directory. Root directories are directories that have no parent directory. ID is generated by the database, it will be ignored if given.

func (*Driver) GetChildren

func (t *Driver) GetChildren(ctx context.Context, parent v1.DirectoryID) ([]v1.DirectoryID, error)

func (*Driver) GetDirectory

func (t *Driver) GetDirectory(ctx context.Context, id v1.DirectoryID) (*v1.Directory, error)

GetDirectoryByID returns a directory by its ID. Note that this call does not give out parent information.

func (*Driver) GetParents

func (t *Driver) GetParents(ctx context.Context, child v1.DirectoryID) ([]v1.DirectoryID, error)

func (*Driver) GetParentsUntilAncestor

func (t *Driver) GetParentsUntilAncestor(
	ctx context.Context,
	child, ancestor v1.DirectoryID,
) ([]v1.DirectoryID, error)

func (*Driver) ListRoots

func (t *Driver) ListRoots(ctx context.Context) ([]v1.DirectoryID, error)

type Options

type Options func(*Driver)

Options defines ways to configure the CRDB driver.

func WithFastReads

func WithFastReads() Options

WithFastReads configures the driver to use fast reads. This is useful for read-only drivers. It will use a different query to read directories, which relies on follower reads. It is important to note that this query will not return the latest data, but it will return data that is consistent with the latest data.

func WithReadOnly

func WithReadOnly() Options

WithReadOnly configures the driver to be read-only.