package migration This package contains utility types for composing and running schema and data migrations in a strictly serial and ordered nature; against a backing kv.SchemaStore implementation.

Package mock is a generated GoMock package.

CorruptScraperError is used when the config cannot be unmarshalled from the bytes stored in the kv.

DecIndexID decodes the bucket val into an influxdb.ID.

DecodeOrgNameKey decodes a raw bucket key into the organization id and name used to create it.

EncBodyJSON JSON encodes the entity body and returns the raw bytes and indicates that it uses the entity body.

EncBytes is a basic pass through for providing raw bytes.

EncID encodes an influx ID.

EncIDKey encodes an entity into a key that represents the encoded ID provided.

Encode concatenates a list of encodings together.

EncString encodes a string.

EncStringCaseInsensitive encodes a string and makes it case insensitive by lower casing everything.

EncUniqKey encodes the unique key.

ErrUnprocessableScraper is used when a scraper is not able to be converted to JSON.

IndexKey returns a value suitable for use as the key component when storing values in the index.

InternalScraperServiceError is used when the error comes from an internal system.

IsNotFound returns a boolean indicating whether the error is known to report that a key or was not found.

NewCursorConfig constructs and configures a CursorConfig used to configure a forward cursor.

NewIndex configures and returns a new *Index for a given index mapping.

NewIndexMapping creates an implementation of IndexMapping for the provided source bucket to a destination index bucket.

NewIndexMigration construct a migration for creating and populating an index.

NewOrgNameKeyStore creates a store for an entity's unique index on organization id and name.

NewService returns an instance of a Service.

NewStaticCursor returns an instance of a StaticCursor.

NewStoreBase creates a new store base.

PutNew will create an entity that is not does not already exist.

PutUpdate will update an entity that must already exist.

UnexpectedIndexError is used when the error comes from an internal system.

UnexpectedScrapersBucketError is used when the error comes from an internal system.

WalkCursor consumers the forward cursor call visit for each k/v pair found.

WithCursorDirection sets the cursor direction on a provided cursor config.

WithCursorHintKeyStart is a hint to the store that the caller is interested in reading keys from start.

WithCursorHintPredicate is a hint to the store to return only key / values which return true for the f.

WithCursorHintPrefix is a hint to the store that the caller is only interested keys with the specified prefix.

WithCursorHints configs the provided hints on the cursor config.

WithCursorLimit restricts the number of key values return by the cursor to the provided limit count.

WithCursorPrefix configures the forward cursor to retrieve keys with a particular prefix.

WithCursorSkipFirstItem skips returning the first item found within the seek.

WithIndexMigationBatchSize configures the size of the batches when committing changes to entire index during migration (e.g.

WithIndexMigrationCleanup removes index entries which point to missing items in the source bucket.

WithIndexReadPathEnabled enables the read paths of the index (Walk) This should be enabled once the index has been fully populated and the Insert and Delete paths are correctly integrated.

CursorAscending directs a cursor to range in ascending order.

CursorAscending directs a cursor to range in descending order.

DefaultSourceID it the default source identifier.

DefaultSourceOrganizationID is the default source's organization identifier.

OpPrefix is the prefix for kv errors.

DefaultSource is the default source.

ErrBucketNotFound is the error returned when the bucket cannot be found.

ErrInvalidScraperID is used when the service was provided an invalid ID format.

ErrInvalidScrapersBucketID is used when the service was provided an invalid ID format.

ErrInvalidScrapersOrgID is used when the service was provided an invalid ID format.

ErrKeyInvalidCharacters is returned when a foreignKey or primaryKey contains .

ErrKeyNotFound is the error returned when the key requested is not found.

ErrKeyValueLogBoundsNotFound is returned when oplog entries cannot be located for the provided bounds.

ErrScraperNotFound is used when the scraper configuration is not found.

ErrSeekMissingPrefix is returned when seek bytes is missing the prefix defined via WithCursorPrefix.

ErrTxNotWritable is the error returned when an mutable operation is called during a non-writable transaction.

NotUniqueError is used when attempting to create a resource that already exists.

CursorConfig is a type used to configure a new forward cursor.

DocumentStore implements influxdb.DocumentStore.

Index is used to define and manage an index for a source bucket.

IndexDiff contains a set of items present in the source not in index, along with a set of things in the index which are not in the source.

IndexMigration is a migration for adding and removing an index.

IndexStore provides a entity store that uses an index lookup.

Pair is a struct for key value pairs.

Service is the struct that influxdb services are implemented on.

ServiceConfig allows us to configure Services.

StoreBase is the base behavior for accessing buckets in kv.

Bucket is the abstraction used to perform get/put/delete/get-many operations in a key value store.

Cursor is an abstraction for iterating/ranging through data.

ForwardCursor is an abstraction for interacting/ranging through data in one direction.

IndexMapping is a type which configures and Index to map items from a source bucket to an index bucket via a mapping known as IndexSourceOn.

SchemaStore is a superset of Store along with store schema change functionality like bucket creation and deletion.

Store is an interface for a generic key value store.

Tx is a transaction in the store.

ConvertValToEntFn converts a key and decoded bucket value to an entity.

CursorDirection is an integer used to define the direction a request cursor operates in.

CursorHint configures CursorHints.

CursorOption is a functional option for configuring a forward cursor.

DecodeBucketValFn decodes the raw []byte.

EncodeEntFn encodes the entity.

EncodeFn returns an encoding when called.

IndexMigrationOption is a functional option for the IndexMigration type.

IndexOption is a function which configures an index.

IndexSourceOnFunc is a function which can be used to derive the foreign key of a value in a source bucket.

VisitFunc is called for each k, v byte slice pair from the underlying source bucket which are found in the index bucket for a provided foreign key.