schema

Documentation

Index

• Constants
• Variables
• func CreateSchemas(ctx context.Context, api *elasticsearch.TypedClient, opts *Options) error
• func Migrate(ctx context.Context, api *elasticsearch.TypedClient, opts *Options) error
• type Option
• type Options

Constants

const (

	// FeedsIndexRO is the index alias for read-only access to feeds.
	FeedsIndexRO = feedsIndexPrefix + indexReadSuffix
	// FeedsIndexRW is the index alias for read-write access to feeds.
	FeedsIndexRW = feedsIndexPrefix + indexWriteSuffix
	// ItemsIndexRO is the index alias for read-only access to items.
	ItemsIndexRO = itemsSchemaPrefix + indexReadSuffix
	// ItemsIndexRW is the index alias for read-write access to items.
	ItemsIndexRW = itemsSchemaPrefix + indexWriteSuffix
	// SubscriptionsIndexRO is the index alias for read-only access to subscriptions.
	SubscriptionsIndexRO = subscriptionsSchemaPrefix + indexReadSuffix
	// SubscriptionsIndexRW is the index alias for read-write access to subscriptions.
	SubscriptionsIndexRW = subscriptionsSchemaPrefix + indexWriteSuffix
	// FavoriteArticlesIndexRO is the index alias for read-only access to subscriptions.
	FavoriteArticlesIndexRO = favoriteItemsSchemaPrefix + indexReadSuffix
	// FavoriteArticlesIndexRW is the index alias for read-only access to subscriptions.
	FavoriteArticlesIndexRW = favoriteItemsSchemaPrefix + indexWriteSuffix
	// UsersIndexRO is the index alias for read-only access to users.
	UsersIndexRO = usersSchemaPrefix + indexReadSuffix
	// UsersIndexRW is the index alias for read-write access to users.
	UsersIndexRW = usersSchemaPrefix + indexWriteSuffix
	// SessionsIndexRO is the index alias for read-only access to session data.
	SessionsIndexRO = sessionsSchemaPrefix + indexReadSuffix
	// SessionsIndexRW is the index alias for read-write access to session data.
	SessionsIndexRW = sessionsSchemaPrefix + indexWriteSuffix
	// SchedulerIndexRO is the index alias for read-only access to scheduler data.
	SchedulerIndexRO = schedulerIndexPrefix + indexReadSuffix
	// SchedulerIndexRW is the index alias for read-write access to scheduler data.
	SchedulerIndexRW = schedulerIndexPrefix + indexWriteSuffix
)

Variables

var (
	FeedStatusIndex = "logs-" + feedStatusIndexPrefix + "-" + config.Version
)

Functions

func CreateSchemas

func CreateSchemas(ctx context.Context, api *elasticsearch.TypedClient, opts *Options) error

CreateSchemas performs all requested schema migrations.

func Migrate

func Migrate(ctx context.Context, api *elasticsearch.TypedClient, opts *Options) error

Migrate performs all requested schema migrations.

Types

type Option

type Option[T any] func(T)

Option is a reusable generic function for applying options to a type.

type Options

type Options struct {
	Indices []string `` /* 151-byte string literal not displayed */
}

Options contains the options for performing schema migrations.