service

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 WithNamespace(ns string) Option
  • func WithReadReplicaLabelKey(key string) Option
  • func WithVolumeName(vn string) Option
• type Rotator
  • func New(replicaID string, opts ...Option) (Rotator, error)

Types

type Option

type Option func(_ *rotator) error

Option represents the functional option for index.

func WithNamespace

func WithNamespace(ns string) Option

func WithReadReplicaLabelKey

func WithReadReplicaLabelKey(key string) Option

func WithVolumeName

func WithVolumeName(vn string) Option

type Rotator

type Rotator interface {
	Start(ctx context.Context) error
}

Rotator represents an interface for indexing.

func New

func New(replicaID string, opts ...Option) (Rotator, error)

New returns Indexer object if no error occurs. replicaID must be a comma separated string of replica id or ${rotateAllID} to rotate all read replica at once.