Documentation
¶
Index ¶
- Constants
- Variables
- type FileDeleteRequest
- type FileEntry
- type FileListRequest
- type FileListResult
- type FileReadRequest
- type FileReadResult
- type FileWriteRequest
- type FileWriteResult
- type FilesBroker
- type Inspector
- type KVBroker
- type KVDeleteRequest
- type KVEntry
- type KVGetRequest
- type KVGetResult
- type KVListRequest
- type KVListResult
- type KVPutRequest
- type KVPutResult
- type Namespace
- type NamespaceRecord
- 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") 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") ErrQuotaExceeded = errors.New("storage quota exceeded") 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 FileDeleteRequest ¶
type FileDeleteRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Path string `json:"path"`
Recursive bool `json:"recursive,omitempty"`
}
type FileListRequest ¶
type FileListRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Path string `json:"path,omitempty"`
MaxEntries int `json:"max_entries,omitempty"`
Cursor string `json:"cursor,omitempty"`
}
type FileListResult ¶
type FileReadRequest ¶
type FileReadRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Path string `json:"path"`
MaxBytes int64 `json:"max_bytes,omitempty"`
}
type FileReadResult ¶
type FileWriteRequest ¶
type FileWriteRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Path string `json:"path"`
Data []byte `json:"-"`
}
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 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 KVDeleteRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Key string `json:"key"`
}
type KVGetRequest ¶
type KVGetRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Key string `json:"key"`
MaxBytes int64 `json:"max_bytes,omitempty"`
}
type KVGetResult ¶
type KVListRequest ¶
type KVListRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Prefix string `json:"prefix,omitempty"`
MaxEntries int `json:"max_entries,omitempty"`
Cursor string `json:"cursor,omitempty"`
}
type KVListResult ¶
type KVPutRequest ¶
type KVPutRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Key string `json:"key"`
Value []byte `json:"-"`
}
type KVPutResult ¶
type Namespace ¶
type Namespace struct {
PluginInstanceID string `json:"plugin_instance_id"`
StoreID string `json:"store_id"`
Kind StoreKind `json:"kind"`
Scope string `json:"scope"`
QuotaBytes int64 `json:"quota_bytes"`
QuotaFiles int64 `json:"quota_files,omitempty"`
SchemaVersion int `json:"schema_version,omitempty"`
}
type NamespaceRecord ¶
type SQLiteBroker ¶
type SQLiteBroker interface {
ExecSQLite(ctx context.Context, req SQLiteExecRequest) (SQLiteExecResult, error)
QuerySQLite(ctx context.Context, req SQLiteQueryRequest) (SQLiteQueryResult, error)
}
type SQLiteExecRequest ¶
type SQLiteExecRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
StoreID string `json:"store_id"`
Database string `json:"database,omitempty"`
SQL string `json:"sql"`
Args []SQLiteValue `json:"args,omitempty"`
Timeout time.Duration `json:"timeout,omitempty"`
}
type SQLiteExecResult ¶
type SQLiteQueryRequest ¶
type SQLiteQueryRequest struct {
PluginInstanceID string `json:"plugin_instance_id"`
ResourceScope sessionctx.ResourceScope `json:"-"`
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.