store

package

Go to main page

Versions in this module

v0

v0.12.0

May 17, 2026

v0.11.0

May 15, 2026

Changes in this version

+ const GroupPublic

+ const KeyPublicHost

+ const KeyPublicMySQLHost

+ const KeyPublicMySQLPort

+ const KeyPublicOraHost

+ const KeyPublicOraPort

+ const KeyPublicPGHost

+ const KeyPublicPGPort

+ var ErrParameterNotFound = errors.New("parameter not found")

type Database

+ Listable bool

type DatabaseUpdate

+ Listable *bool

+ type GlobalParameter struct

+ CreatedAt time.Time

+ DeletedAt *time.Time

+ GroupKey string

+ Key string

+ UID uuid.UUID

+ UpdatedAt time.Time

+ Value string

+ type PublicEndpoints struct

+ Host string

+ MySQLHost string

+ MySQLPort *int

+ OraHost string

+ OraPort *int

+ PGHost string

+ PGPort *int

+ type ResolvedEndpoints struct

+ MySQLHost string

+ MySQLPort int

+ OraHost string

+ OraPort int

+ PGHost string

+ PGPort int

+ func ResolvePublicEndpoints(pe PublicEndpoints, cfg *config.Config) ResolvedEndpoints

type Store

+ func (s *Store) DeleteParameter(ctx context.Context, groupKey, key string) error

+ func (s *Store) GetAllParameters(ctx context.Context, groupKey string) ([]GlobalParameter, error)

+ func (s *Store) GetParameter(ctx context.Context, groupKey, key string) (*GlobalParameter, error)

+ func (s *Store) GetParameters(ctx context.Context, groupKey string) ([]GlobalParameter, error)

+ func (s *Store) GetPublicEndpoints(ctx context.Context) (PublicEndpoints, error)

+ func (s *Store) ListListableDatabases(ctx context.Context) ([]Database, error)

+ func (s *Store) SetParameter(ctx context.Context, groupKey, key, value string) error

+ func (s *Store) SetPublicEndpoints(ctx context.Context, pe PublicEndpoints) error

v0.10.1

May 11, 2026

Changes in this version

type Store

+ func (s *Store) GetIdentityByProviderID(ctx context.Context, provider, providerID string) (*UserIdentity, error)

v0.10.0

May 10, 2026

Changes in this version

+ var ErrDefinitionInactive = errors.New("grant definition is no longer active")

+ var ErrGrantDefinitionDuplicate = errors.New("grant definition with this name already exists")

+ var ErrGrantDefinitionNotFound = errors.New("grant definition not found")

+ var ErrGrantRequestNotFound = errors.New("grant request not found")

+ var ErrInvalidTransition = errors.New("grant request not pending")

type Grant

+ func BuildGrantFromDefinition(def *GrantDefinition, userID, databaseID, grantedBy uuid.UUID, now time.Time) *Grant

+ type GrantDefinition struct

+ Controls []string

+ CreatedAt time.Time

+ CreatedBy uuid.UUID

+ Description string

+ DurationSeconds int64

+ IsActive bool

+ MaxBytesTransferred *int64

+ MaxQueryCounts *int64

+ Name string

+ UID uuid.UUID

+ type GrantDefinitionFilter struct

+ ActiveOnly bool

+ type GrantRequest struct

+ DatabaseID uuid.UUID

+ DecidedAt *time.Time

+ DecidedBy *uuid.UUID

+ DecisionReason *string

+ GrantDefinitionID uuid.UUID

+ Justification string

+ RequestedAt time.Time

+ ResultingGrantID *uuid.UUID

+ SlackChannel *string

+ SlackMessageTS *string

+ Status GrantRequestStatus

+ UID uuid.UUID

+ UserID uuid.UUID

+ type GrantRequestFilter struct

+ DatabaseID *uuid.UUID

+ Limit int

+ Offset int

+ Status *GrantRequestStatus

+ UserID *uuid.UUID

+ type GrantRequestStatus string

+ const GrantRequestApproved

+ const GrantRequestCancelled

+ const GrantRequestDenied

+ const GrantRequestExpired

+ const GrantRequestPending

type Store

+ func (s *Store) ApproveGrantRequest(ctx context.Context, uid, decidedBy uuid.UUID) (*Grant, *GrantRequest, error)

+ func (s *Store) CancelGrantRequest(ctx context.Context, uid, byUser uuid.UUID) (*GrantRequest, error)

+ func (s *Store) CreateGrantDefinition(ctx context.Context, def *GrantDefinition) (*GrantDefinition, error)

+ func (s *Store) CreateGrantRequest(ctx context.Context, req *GrantRequest) (*GrantRequest, error)

+ func (s *Store) DeactivateGrantDefinition(ctx context.Context, uid uuid.UUID) error

+ func (s *Store) DenyGrantRequest(ctx context.Context, uid, decidedBy uuid.UUID, reason string) (*GrantRequest, error)

+ func (s *Store) GetGrantDefinition(ctx context.Context, uid uuid.UUID) (*GrantDefinition, error)

+ func (s *Store) GetGrantRequest(ctx context.Context, uid uuid.UUID) (*GrantRequest, error)

+ func (s *Store) HasPendingRequest(ctx context.Context, userID, definitionID, databaseID uuid.UUID) (bool, error)

+ func (s *Store) ListGrantDefinitions(ctx context.Context, filter GrantDefinitionFilter) ([]GrantDefinition, error)

+ func (s *Store) ListGrantRequests(ctx context.Context, filter GrantRequestFilter) ([]GrantRequest, error)

+ func (s *Store) SetGrantRequestSlackMessage(ctx context.Context, uid uuid.UUID, channel, ts string) error

+ func (s *Store) UpdateGrantDefinition(ctx context.Context, def *GrantDefinition) error

v0.9.0

May 8, 2026

v0.8.0

May 6, 2026

v0.7.0

May 6, 2026

Changes in this version

+ const ProtocolMariaDB

+ const ProtocolMySQL

+ func IsMySQLFamily(protocol string) bool

v0.6.0

Apr 15, 2026

v0.5.2

Apr 14, 2026

v0.5.1

Apr 14, 2026

v0.5.0

Apr 14, 2026

Changes in this version

+ var ErrAPIKeyTooShort = errors.New("API key too short")

type APIKey

+ O5LogonSalt []byte

+ O5LogonVerifier []byte

type AuditFilter

+ BeforeUID *uuid.UUID

type ConnectionFilter

+ BeforeUID *uuid.UUID

type QueryFilter

+ BeforeUID *uuid.UUID

type Store

+ func (s *Store) CreateAPIKeyWithValue(ctx context.Context, userID uuid.UUID, name string, plainKey string, ...) (*APIKey, error)

v0.4.0

Apr 4, 2026

Changes in this version

+ const IdentityTypeSlack

+ const ProtocolOracle

+ const ProtocolPostgreSQL

+ var ErrIdentityNotFound = errors.New("identity not found")

+ var ErrOAuthStateNotFound = errors.New("oauth state not found")

type Database

+ OracleServiceName *string

+ Protocol string

type DatabaseUpdate

+ OracleServiceName *string

+ Protocol *string

+ type OAuthState struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ Metadata json.RawMessage

+ Provider string

+ RedirectURL string

+ State string

+ UID uuid.UUID

type Store

+ func (s *Store) CleanupExpiredOAuthStates(ctx context.Context) (int64, error)

+ func (s *Store) ConsumeOAuthState(ctx context.Context, stateToken string) (*OAuthState, error)

+ func (s *Store) CreateOAuthState(ctx context.Context, state *OAuthState) (*OAuthState, error)

+ func (s *Store) CreateUserIdentity(ctx context.Context, identity *UserIdentity) (*UserIdentity, error)

+ func (s *Store) DeleteUserIdentity(ctx context.Context, uid uuid.UUID) error

+ func (s *Store) GetDatabaseByOracleServiceName(ctx context.Context, serviceName string) (*Database, error)

+ func (s *Store) GetUserByIdentity(ctx context.Context, provider, providerID string) (*User, error)

+ func (s *Store) GetUserIdentities(ctx context.Context, userID uuid.UUID) ([]UserIdentity, error)

+ func (s *Store) GetUserIdentity(ctx context.Context, uid uuid.UUID) (*UserIdentity, error)

+ func (s *Store) UpdateQueryCompletion(ctx context.Context, uid uuid.UUID, durationMs *float64, rowsAffected *int64, ...) error

+ type UserIdentity struct

+ CreatedAt time.Time

+ DeletedAt *time.Time

+ DisplayName string

+ Email string

+ Metadata json.RawMessage

+ Provider string

+ ProviderID string

+ UID uuid.UUID

+ UpdatedAt time.Time

+ UserID uuid.UUID

v0.3.0

Jan 24, 2026

v0.2.0

Jan 15, 2026

v0.1.0

Jan 12, 2026

Changes in this version

type Store

+ func (s *Store) SetAuthCache(authCache *cache.AuthCache)

v0.0.2

Jan 12, 2026

v0.0.1

Jan 11, 2026

v0.0.0

Jan 11, 2026

Changes in this version

+ const APIKeyPrefix

+ const APIKeyPrefixLength

+ const APIKeyRandomLength

+ const ControlBlockCopy

+ const ControlBlockDDL

+ const ControlReadOnly

+ const DefaultQueryRowsLimit

+ const KeyTypeAPI

+ const KeyTypeWeb

+ const MaxQueryRowsDataSize

+ const MaxQueryRowsLimit

+ const RoleAdmin

+ const RoleConnector

+ const RoleViewer

+ const WebKeyPrefix

+ const WebSessionMaxDuration

+ var ErrAPIKeyExpired = errors.New("API key has expired")

+ var ErrAPIKeyNotFound = errors.New("API key not found")

+ var ErrAPIKeyRevoked = errors.New("API key has been revoked")

+ var ErrConnectionNotFound = errors.New("connection not found or already closed")

+ var ErrDatabaseNotFound = errors.New("database not found")

+ var ErrGrantAlreadyRevoked = errors.New("grant not found or already revoked")

+ var ErrGrantNotFound = errors.New("grant not found")

+ var ErrInvalidCursor = errors.New("invalid cursor")

+ var ErrNoActiveGrant = errors.New("no active grant found")

+ var ErrQueryNotFound = errors.New("query not found")

+ var ErrTargetMatchesStorage = errors.New("target database cannot match DBBat storage database")

+ var ErrUserNotFound = errors.New("user not found")

+ var ValidControls = []string

+ func ExtractSourceIP(addr net.Addr) string

+ type APIKey struct

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ ID uuid.UUID

+ KeyHash string

+ KeyPrefix string

+ KeyType string

+ LastUsedAt *time.Time

+ Name string

+ RequestCount int64

+ RevokedAt *time.Time

+ RevokedBy *uuid.UUID

+ UserID uuid.UUID

+ func (k *APIKey) IsExpired() bool

+ func (k *APIKey) IsRevoked() bool

+ func (k *APIKey) IsValid() bool

+ func (k *APIKey) IsWebSession() bool

+ type APIKeyFilter struct

+ IncludeAll bool

+ KeyType *string

+ Limit int

+ Offset int

+ UserID *uuid.UUID

+ type AccessGrant struct

+ BytesTransferred int64

+ Controls []string

+ CreatedAt time.Time

+ DatabaseID uuid.UUID

+ ExpiresAt time.Time

+ GrantedBy uuid.UUID

+ MaxBytesTransferred *int64

+ MaxQueryCounts *int64

+ QueryCount int64

+ RevokedAt *time.Time

+ RevokedBy *uuid.UUID

+ StartsAt time.Time

+ UID uuid.UUID

+ UserID uuid.UUID

+ func (g *AccessGrant) HasControl(control string) bool

+ func (g *AccessGrant) IsReadOnly() bool

+ func (g *AccessGrant) ShouldBlockCopy() bool

+ func (g *AccessGrant) ShouldBlockDDL() bool

+ type AuditEvent = AuditLog

+ type AuditFilter struct

+ EndTime *time.Time

+ EventType *string

+ Limit int

+ Offset int

+ PerformedBy *uuid.UUID

+ StartTime *time.Time

+ UserID *uuid.UUID

+ type AuditLog struct

+ CreatedAt time.Time

+ Details json.RawMessage

+ EventType string

+ PerformedBy *uuid.UUID

+ UID uuid.UUID

+ UserID *uuid.UUID

+ type Connection struct

+ BytesTransferred int64

+ ConnectedAt time.Time

+ DatabaseID uuid.UUID

+ DisconnectedAt *time.Time

+ LastActivityAt time.Time

+ Queries int64

+ SourceIP string

+ UID uuid.UUID

+ UserID uuid.UUID

+ type ConnectionFilter struct

+ DatabaseID *uuid.UUID

+ Limit int

+ Offset int

+ UserID *uuid.UUID

+ type DSNComponents struct

+ Database string

+ Host string

+ Port string

+ type Database struct

+ CreatedAt time.Time

+ CreatedBy *uuid.UUID

+ DatabaseName string

+ DeletedAt *time.Time

+ Description string

+ Host string

+ Name string

+ Password string

+ PasswordEncrypted []byte

+ Port int

+ SSLMode string

+ UID uuid.UUID

+ UpdatedAt time.Time

+ Username string

+ func (db *Database) DecryptPassword(encryptionKey []byte) error

+ type DatabaseUpdate struct

+ DatabaseName *string

+ Description *string

+ Host *string

+ Password *string

+ Port *int

+ SSLMode *string

+ Username *string

+ type Grant = AccessGrant

+ type GrantFilter struct

+ ActiveOnly bool

+ DatabaseID *uuid.UUID

+ UserID *uuid.UUID

+ type MigrationInfo struct

+ MigratedAt time.Time

+ Name string

+ type Options struct

+ DropTablesFirst bool

+ type Query struct

+ ConnectionID uuid.UUID

+ CopyDirection *string

+ CopyFormat *string

+ DurationMs *float64

+ Error *string

+ ExecutedAt time.Time

+ Parameters *QueryParameters

+ RowsAffected *int64

+ SQLText string

+ UID uuid.UUID

+ func (q *Query) BeforeAppendModel(_ context.Context, _ bun.Query) error

+ type QueryFilter struct

+ ConnectionID *uuid.UUID

+ DatabaseID *uuid.UUID

+ EndTime *time.Time

+ Limit int

+ Offset int

+ StartTime *time.Time

+ UserID *uuid.UUID

+ type QueryParameters struct

+ FormatCodes []int16

+ Raw []string

+ TypeOIDs []uint32

+ Values []string

+ type QueryRow struct

+ RowData json.RawMessage

+ RowNumber int

+ RowSizeBytes int64

+ type QueryRowModel struct

+ QueryID uuid.UUID

+ RowData json.RawMessage

+ RowNumber int

+ RowSizeBytes int64

+ UID uuid.UUID

+ type QueryRowsCursor struct

+ Offset int64

+ type QueryRowsResult struct

+ HasMore bool

+ NextCursor string

+ Rows []QueryRow

+ TotalRows int64

+ type QueryWithRows struct

+ Rows []QueryRow

+ type Store struct

+ func New(ctx context.Context, dsn string, opts ...Options) (*Store, error)

+ func (s *Store) Close()

+ func (s *Store) CloseConnection(ctx context.Context, uid uuid.UUID) error

+ func (s *Store) CreateAPIKey(ctx context.Context, userID uuid.UUID, name string, expiresAt *time.Time) (*APIKey, string, error)

+ func (s *Store) CreateConnection(ctx context.Context, userID, databaseID uuid.UUID, sourceIP string) (*Connection, error)

+ func (s *Store) CreateDatabase(ctx context.Context, db *Database, encryptionKey []byte) (*Database, error)

+ func (s *Store) CreateGrant(ctx context.Context, grant *Grant) (*Grant, error)

+ func (s *Store) CreateQuery(ctx context.Context, query *Query) (*Query, error)

+ func (s *Store) CreateUser(ctx context.Context, username, passwordHash string, roles []string) (*User, error)

+ func (s *Store) CreateWebSession(ctx context.Context, userID uuid.UUID) (*APIKey, string, error)

+ func (s *Store) DB() *bun.DB

+ func (s *Store) DeleteDatabase(ctx context.Context, uid uuid.UUID) error

+ func (s *Store) DeleteUser(ctx context.Context, uid uuid.UUID) error

+ func (s *Store) DropAllTables(ctx context.Context) error

+ func (s *Store) EnsureDefaultAdmin(ctx context.Context, passwordHash string) error

+ func (s *Store) GetAPIKeyByID(ctx context.Context, id uuid.UUID) (*APIKey, error)

+ func (s *Store) GetAPIKeyByPrefix(ctx context.Context, prefix string) (*APIKey, error)

+ func (s *Store) GetActiveGrant(ctx context.Context, userID, databaseID uuid.UUID) (*Grant, error)

+ func (s *Store) GetDatabaseByName(ctx context.Context, name string) (*Database, error)

+ func (s *Store) GetDatabaseByUID(ctx context.Context, uid uuid.UUID) (*Database, error)

+ func (s *Store) GetGrantByUID(ctx context.Context, uid uuid.UUID) (*Grant, error)

+ func (s *Store) GetQuery(ctx context.Context, uid uuid.UUID) (*Query, error)

+ func (s *Store) GetQueryRows(ctx context.Context, queryUID uuid.UUID, cursor string, limit int) (*QueryRowsResult, error)

+ func (s *Store) GetQueryWithRows(ctx context.Context, uid uuid.UUID) (*QueryWithRows, error)

+ func (s *Store) GetUserByUID(ctx context.Context, uid uuid.UUID) (*User, error)

+ func (s *Store) GetUserByUsername(ctx context.Context, username string) (*User, error)

+ func (s *Store) Health(ctx context.Context) error

+ func (s *Store) IncrementAPIKeyUsage(ctx context.Context, id uuid.UUID) error

+ func (s *Store) IncrementBytesTransferred(_ context.Context, _ uuid.UUID, _ int64) error

+ func (s *Store) IncrementConnectionStats(ctx context.Context, uid uuid.UUID, bytes int64) error

+ func (s *Store) IncrementQueryCount(_ context.Context, _ uuid.UUID) error

+ func (s *Store) ListAPIKeys(ctx context.Context, filter APIKeyFilter) ([]APIKey, error)

+ func (s *Store) ListAuditEvents(ctx context.Context, filter AuditFilter) ([]AuditEvent, error)

+ func (s *Store) ListConnections(ctx context.Context, filter ConnectionFilter) ([]Connection, error)

+ func (s *Store) ListDatabases(ctx context.Context) ([]Database, error)

+ func (s *Store) ListGrants(ctx context.Context, filter GrantFilter) ([]Grant, error)

+ func (s *Store) ListQueries(ctx context.Context, filter QueryFilter) ([]Query, error)

+ func (s *Store) ListUsers(ctx context.Context) ([]User, error)

+ func (s *Store) LogAuditEvent(ctx context.Context, event *AuditEvent) error

+ func (s *Store) MatchesStorageDSN(host string, port int, databaseName string) bool

+ func (s *Store) Migrate(ctx context.Context) error

+ func (s *Store) MigrationStatus(ctx context.Context) ([]MigrationInfo, error)

+ func (s *Store) RevokeAPIKey(ctx context.Context, id uuid.UUID, revokedBy uuid.UUID) error

+ func (s *Store) RevokeGrant(ctx context.Context, uid uuid.UUID, revokedBy uuid.UUID) error

+ func (s *Store) Rollback(ctx context.Context) error

+ func (s *Store) StoreQueryRows(ctx context.Context, queryUID uuid.UUID, rows []QueryRow) error

+ func (s *Store) UpdateConnectionActivity(ctx context.Context, uid uuid.UUID) error

+ func (s *Store) UpdateDatabase(ctx context.Context, uid uuid.UUID, updates DatabaseUpdate, ...) error

+ func (s *Store) UpdateUser(ctx context.Context, uid uuid.UUID, updates UserUpdate) error

+ func (s *Store) VerifyAPIKey(ctx context.Context, plainKey string) (*APIKey, error)

+ type User struct

+ CreatedAt time.Time

+ DeletedAt *time.Time

+ PasswordChangedAt *time.Time

+ PasswordHash string

+ RateLimitExempt bool

+ Roles []string

+ UID uuid.UUID

+ UpdatedAt time.Time

+ Username string

+ func (u *User) HasChangedPassword() bool

+ func (u *User) HasRole(role string) bool

+ func (u *User) IsAdmin() bool

+ func (u *User) IsConnector() bool

+ func (u *User) IsViewer() bool

+ type UserUpdate struct

+ PasswordHash *string

+ Roles []string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL