Documentation
¶
Index ¶
- Constants
- Variables
- type ArchiveRecord
- type BindRetainedRequest
- type Broker
- type ExportRequest
- type FileBroker
- func (b *FileBroker) BindRetainedNamespace(ctx context.Context, req BindRetainedRequest) error
- func (b *FileBroker) DeleteFile(ctx context.Context, req FileDeleteRequest) error
- func (b *FileBroker) DeleteKV(ctx context.Context, req KVDeleteRequest) error
- func (b *FileBroker) DeleteNamespace(ctx context.Context, pluginInstanceID string, deleteData bool) error
- func (b *FileBroker) DeleteRetainedNamespace(ctx context.Context, pluginInstanceID string) error
- func (b *FileBroker) EnsureNamespace(ctx context.Context, ns Namespace) error
- func (b *FileBroker) ExecSQLite(ctx context.Context, req SQLiteExecRequest) (SQLiteExecResult, error)
- func (b *FileBroker) ExportData(ctx context.Context, req ExportRequest) (string, error)
- func (b *FileBroker) GetKV(ctx context.Context, req KVGetRequest) (KVGetResult, error)
- func (b *FileBroker) ImportData(ctx context.Context, req ImportRequest) error
- func (b *FileBroker) ListFiles(ctx context.Context, req FileListRequest) (FileListResult, error)
- func (b *FileBroker) ListKV(ctx context.Context, req KVListRequest) (KVListResult, error)
- func (b *FileBroker) ListNamespaces(ctx context.Context, pluginInstanceID string) ([]NamespaceRecord, error)
- func (b *FileBroker) NamespacePath(ctx context.Context, pluginInstanceID string, storeID string) (string, error)
- func (b *FileBroker) PutKV(ctx context.Context, req KVPutRequest) (KVPutResult, error)
- func (b *FileBroker) QuerySQLite(ctx context.Context, req SQLiteQueryRequest) (SQLiteQueryResult, error)
- func (b *FileBroker) ReadFile(ctx context.Context, req FileReadRequest) (FileReadResult, error)
- func (b *FileBroker) Root() string
- func (b *FileBroker) Usage(ctx context.Context, pluginInstanceID string, storeID string) (Usage, error)
- func (b *FileBroker) WriteFile(ctx context.Context, req FileWriteRequest) (FileWriteResult, error)
- type FileDeleteRequest
- type FileEntry
- type FileListRequest
- type FileListResult
- type FileReadRequest
- type FileReadResult
- type FileWriteRequest
- type FileWriteResult
- type FilesBroker
- type ImportRequest
- type Inspector
- type KVBroker
- type KVDeleteRequest
- type KVEntry
- type KVGetRequest
- type KVGetResult
- type KVListRequest
- type KVListResult
- type KVPutRequest
- type KVPutResult
- type MemoryBroker
- func (b *MemoryBroker) Archive(ref string) (ArchiveRecord, bool)
- func (b *MemoryBroker) BindRetainedNamespace(_ context.Context, req BindRetainedRequest) error
- func (b *MemoryBroker) DeleteKV(_ context.Context, req KVDeleteRequest) error
- func (b *MemoryBroker) DeleteNamespace(_ context.Context, pluginInstanceID string, deleteData bool) error
- func (b *MemoryBroker) DeleteRetainedNamespace(_ context.Context, pluginInstanceID string) error
- func (b *MemoryBroker) EnsureNamespace(_ context.Context, ns Namespace) error
- func (b *MemoryBroker) ExportData(_ context.Context, req ExportRequest) (string, error)
- func (b *MemoryBroker) GetKV(_ context.Context, req KVGetRequest) (KVGetResult, error)
- func (b *MemoryBroker) ImportData(_ context.Context, req ImportRequest) error
- func (b *MemoryBroker) ListKV(_ context.Context, req KVListRequest) (KVListResult, error)
- func (b *MemoryBroker) ListNamespaces(_ context.Context, pluginInstanceID string) ([]NamespaceRecord, error)
- func (b *MemoryBroker) PutKV(_ context.Context, req KVPutRequest) (KVPutResult, error)
- func (b *MemoryBroker) SetUsage(_ context.Context, pluginInstanceID string, storeID string, usageBytes int64) error
- func (b *MemoryBroker) Usage(_ context.Context, pluginInstanceID string, storeID string) (Usage, error)
- type Namespace
- type NamespacePathResolver
- type NamespaceRecord
- type NamespaceState
- type RetainedBinder
- type RetainedDeleter
- type SQLiteBroker
- type SQLiteExecRequest
- type SQLiteExecResult
- type SQLiteQueryRequest
- type SQLiteQueryResult
- type SQLiteValue
- type StoreKind
- type Usage
Constants ¶
View Source
const MaxKVKeyBytes = 128
Variables ¶
View Source
var ( ErrInvalidNamespace = errors.New("storage namespace is invalid") ErrNamespaceAlreadyExists = errors.New("storage namespace already exists") ErrInvalidFilePath = errors.New("storage file path is invalid") ErrInvalidKVKey = errors.New("storage kv key is invalid") ErrInvalidSQLite = errors.New("storage sqlite request is invalid") ErrNamespaceNotFound = errors.New("storage namespace not found") ErrNamespaceNotRetained = errors.New("storage namespace is not retained") ErrQuotaExceeded = errors.New("storage quota exceeded") ErrArchiveNotFound = errors.New("storage archive not found") ErrFileNotFound = errors.New("storage file not found") ErrFileTooLarge = errors.New("storage file too large") ErrKVKeyNotFound = errors.New("storage kv key not found") ErrKVValueTooLarge = errors.New("storage kv value too large") ErrSQLiteResultTooLarge = errors.New("storage sqlite result too large") )
Functions ¶
This section is empty.
Types ¶
type ArchiveRecord ¶
type BindRetainedRequest ¶
type BindRetainedRequest struct {
SourcePluginInstanceID string `json:"source_plugin_instance_id"`
TargetPluginInstanceID string `json:"target_plugin_instance_id"`
TargetNamespaces []Namespace `json:"target_namespaces,omitempty"`
DryRun bool `json:"dry_run,omitempty"`
Now time.Time `json:"now,omitempty"`
}
type ExportRequest ¶
type FileBroker ¶
type FileBroker struct {
// contains filtered or unexported fields
}
func NewFileBroker ¶
func NewFileBroker(root string) (*FileBroker, error)
func (*FileBroker) BindRetainedNamespace ¶
func (b *FileBroker) BindRetainedNamespace(ctx context.Context, req BindRetainedRequest) error
func (*FileBroker) DeleteFile ¶
func (b *FileBroker) DeleteFile(ctx context.Context, req FileDeleteRequest) error
func (*FileBroker) DeleteKV ¶
func (b *FileBroker) DeleteKV(ctx context.Context, req KVDeleteRequest) error
func (*FileBroker) DeleteNamespace ¶
func (*FileBroker) DeleteRetainedNamespace ¶
func (b *FileBroker) DeleteRetainedNamespace(ctx context.Context, pluginInstanceID string) error
func (*FileBroker) EnsureNamespace ¶
func (b *FileBroker) EnsureNamespace(ctx context.Context, ns Namespace) error
func (*FileBroker) ExecSQLite ¶
func (b *FileBroker) ExecSQLite(ctx context.Context, req SQLiteExecRequest) (SQLiteExecResult, error)
func (*FileBroker) ExportData ¶
func (b *FileBroker) ExportData(ctx context.Context, req ExportRequest) (string, error)
func (*FileBroker) GetKV ¶
func (b *FileBroker) GetKV(ctx context.Context, req KVGetRequest) (KVGetResult, error)
func (*FileBroker) ImportData ¶
func (b *FileBroker) ImportData(ctx context.Context, req ImportRequest) error
func (*FileBroker) ListFiles ¶
func (b *FileBroker) ListFiles(ctx context.Context, req FileListRequest) (FileListResult, error)
func (*FileBroker) ListKV ¶
func (b *FileBroker) ListKV(ctx context.Context, req KVListRequest) (KVListResult, error)
func (*FileBroker) ListNamespaces ¶
func (b *FileBroker) ListNamespaces(ctx context.Context, pluginInstanceID string) ([]NamespaceRecord, error)
func (*FileBroker) NamespacePath ¶
func (*FileBroker) PutKV ¶
func (b *FileBroker) PutKV(ctx context.Context, req KVPutRequest) (KVPutResult, error)
func (*FileBroker) QuerySQLite ¶
func (b *FileBroker) QuerySQLite(ctx context.Context, req SQLiteQueryRequest) (SQLiteQueryResult, error)
func (*FileBroker) ReadFile ¶
func (b *FileBroker) ReadFile(ctx context.Context, req FileReadRequest) (FileReadResult, error)
func (*FileBroker) Root ¶
func (b *FileBroker) Root() string
func (*FileBroker) WriteFile ¶
func (b *FileBroker) WriteFile(ctx context.Context, req FileWriteRequest) (FileWriteResult, error)
type FileDeleteRequest ¶
type FileListRequest ¶
type FileListResult ¶
type FileReadRequest ¶
type FileReadResult ¶
type FileWriteRequest ¶
type FileWriteResult ¶
type FilesBroker ¶
type FilesBroker interface {
ReadFile(ctx context.Context, req FileReadRequest) (FileReadResult, error)
WriteFile(ctx context.Context, req FileWriteRequest) (FileWriteResult, error)
DeleteFile(ctx context.Context, req FileDeleteRequest) error
ListFiles(ctx context.Context, req FileListRequest) (FileListResult, error)
}
type ImportRequest ¶
type KVBroker ¶
type KVBroker interface {
GetKV(ctx context.Context, req KVGetRequest) (KVGetResult, error)
PutKV(ctx context.Context, req KVPutRequest) (KVPutResult, error)
DeleteKV(ctx context.Context, req KVDeleteRequest) error
ListKV(ctx context.Context, req KVListRequest) (KVListResult, error)
}
type KVDeleteRequest ¶
type KVGetRequest ¶
type KVGetResult ¶
type KVListRequest ¶
type KVListResult ¶
type KVPutRequest ¶
type KVPutResult ¶
type MemoryBroker ¶
type MemoryBroker struct {
// contains filtered or unexported fields
}
func NewMemoryBroker ¶
func NewMemoryBroker() *MemoryBroker
func (*MemoryBroker) Archive ¶
func (b *MemoryBroker) Archive(ref string) (ArchiveRecord, bool)
func (*MemoryBroker) BindRetainedNamespace ¶
func (b *MemoryBroker) BindRetainedNamespace(_ context.Context, req BindRetainedRequest) error
func (*MemoryBroker) DeleteKV ¶
func (b *MemoryBroker) DeleteKV(_ context.Context, req KVDeleteRequest) error
func (*MemoryBroker) DeleteNamespace ¶
func (*MemoryBroker) DeleteRetainedNamespace ¶
func (b *MemoryBroker) DeleteRetainedNamespace(_ context.Context, pluginInstanceID string) error
func (*MemoryBroker) EnsureNamespace ¶
func (b *MemoryBroker) EnsureNamespace(_ context.Context, ns Namespace) error
func (*MemoryBroker) ExportData ¶
func (b *MemoryBroker) ExportData(_ context.Context, req ExportRequest) (string, error)
func (*MemoryBroker) GetKV ¶
func (b *MemoryBroker) GetKV(_ context.Context, req KVGetRequest) (KVGetResult, error)
func (*MemoryBroker) ImportData ¶
func (b *MemoryBroker) ImportData(_ context.Context, req ImportRequest) error
func (*MemoryBroker) ListKV ¶
func (b *MemoryBroker) ListKV(_ context.Context, req KVListRequest) (KVListResult, error)
func (*MemoryBroker) ListNamespaces ¶
func (b *MemoryBroker) ListNamespaces(_ context.Context, pluginInstanceID string) ([]NamespaceRecord, error)
func (*MemoryBroker) PutKV ¶
func (b *MemoryBroker) PutKV(_ context.Context, req KVPutRequest) (KVPutResult, error)
type Namespace ¶
type Namespace struct {
PluginInstanceID string `json:"plugin_instance_id"`
StoreID string `json:"store_id"`
Kind StoreKind `json:"kind"`
Scope string `json:"scope,omitempty"`
QuotaBytes int64 `json:"quota_bytes"`
QuotaFiles int64 `json:"quota_files,omitempty"`
SchemaVersion int `json:"schema_version,omitempty"`
}
type NamespacePathResolver ¶
type NamespaceRecord ¶
type NamespaceState ¶
type NamespaceState string
const ( NamespaceActive NamespaceState = "active" NamespaceRetained NamespaceState = "retained" )
type RetainedBinder ¶
type RetainedBinder interface {
BindRetainedNamespace(ctx context.Context, req BindRetainedRequest) error
}
type RetainedDeleter ¶
type SQLiteBroker ¶
type SQLiteBroker interface {
ExecSQLite(ctx context.Context, req SQLiteExecRequest) (SQLiteExecResult, error)
QuerySQLite(ctx context.Context, req SQLiteQueryRequest) (SQLiteQueryResult, error)
}
type SQLiteExecRequest ¶
type SQLiteExecResult ¶
type SQLiteQueryRequest ¶
type SQLiteQueryRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
StoreID string `json:"store_id"`
Database string `json:"database,omitempty"`
SQL string `json:"sql"`
Args []SQLiteValue `json:"args,omitempty"`
MaxRows int `json:"max_rows,omitempty"`
MaxResponseBytes int64 `json:"max_response_bytes,omitempty"`
Timeout time.Duration `json:"timeout,omitempty"`
}
type SQLiteQueryResult ¶
type SQLiteQueryResult struct {
Database string `json:"database"`
Columns []string `json:"columns"`
Rows [][]SQLiteValue `json:"rows"`
Usage Usage `json:"usage"`
}
type SQLiteValue ¶
Click to show internal directories.
Click to hide internal directories.