pogreb

Documentation

Overview

Copyright (C) 2019-2024 vdaas.org vald team <vald@vdaas.org>

Licensed under the Apache License, Version 2.0 (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (C) 2019-2024 vdaas.org vald team <vald@vdaas.org>

Licensed under the Apache License, Version 2.0 (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Option
  • func WithBackgroundCompactionInterval(s string) Option
  • func WithBackgroundSyncInterval(s string) Option
  • func WithPath(path string) Option
• type Pogreb
  • func New(opts ...Option) (_ Pogreb, err error)

Types

type Option

type Option func(*db) error

Option represents the functional option for database.

func WithBackgroundCompactionInterval

func WithBackgroundCompactionInterval(s string) Option

WithBackgroundCompactionInterval returns the option to sets the amount of time between background Compact() calls. Setting the value to 0 or less disables the automatic background compaction.

func WithBackgroundSyncInterval

func WithBackgroundSyncInterval(s string) Option

WithBackgroundSyncInterval returns the option to sets the amount of time between background Sync() calls. Setting the value to 0 disables the automatic background synchronization. Setting the value to -1 or less makes the DB call Sync() after every write operation.

func WithPath

func WithPath(path string) Option

WithPath returns the option to set path.

type Pogreb

type Pogreb interface {
	Set(key string, val []byte) error
	Get(key string) ([]byte, bool, error)
	Delete(key string) error
	Range(ctx context.Context, f func(key string, val []byte) bool) error
	Len() uint32
	Close(remove bool) error
}

Pogreb represents an interface for operating the pogreb database.

func New

func New(opts ...Option) (_ Pogreb, err error)

New returns a new pogreb instance. If the directory path does not exist, it creates a directory for database. If opts is nil, it uses default options.