bbolt

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 Bbolt
  • func New(file, bucket string, mode fs.FileMode, opts ...Option) (Bbolt, error)
• type Option
  • func WithInitialMmapSize(initialMmapSize int) Option
  • func WithMlock(mlock bool) Option
  • func WithMmapFlags(flags int) Option
  • func WithNoFreeListSync(noFreeListSync bool) Option
  • func WithNoGrowSync(noGrowSync bool) Option
  • func WithNoSync(noSync bool) Option
  • func WithPageSize(pageSize int) Option
  • func WithPreLoadFreelist(preloadFreelist bool) Option
  • func WithReadOnly(readOnly bool) Option
  • func WithTimeout(dur time.Duration) Option

Types

type Bbolt

type Bbolt interface {
	Set(key, val []byte) error
	Get(key []byte) ([]byte, bool, error)
	AsyncSet(eg errgroup.Group, key, val []byte)
	Close(remove bool) error
}

func New

func New(file, bucket string, mode fs.FileMode, opts ...Option) (Bbolt, error)

New returns a new Bbolt instance. If file does not exist, it creates a new file. If bucket is empty, it uses default_bucket. If opts is nil, it uses default options.

type Option

type Option func(*bolt.Options) error

func WithInitialMmapSize

func WithInitialMmapSize(initialMmapSize int) Option

func WithMlock

func WithMlock(mlock bool) Option

func WithMmapFlags

func WithMmapFlags(flags int) Option

func WithNoFreeListSync

func WithNoFreeListSync(noFreeListSync bool) Option

func WithNoGrowSync

func WithNoGrowSync(noGrowSync bool) Option

func WithNoSync

func WithNoSync(noSync bool) Option

func WithPageSize

func WithPageSize(pageSize int) Option

func WithPreLoadFreelist

func WithPreLoadFreelist(preloadFreelist bool) Option

func WithReadOnly

func WithReadOnly(readOnly bool) Option

func WithTimeout

func WithTimeout(dur time.Duration) Option