README
¶
gosmo
SQLServer Management Objects Library A Go library that mimics Microsoft SQL Server Management Objects (SMO) — without WMI, COM, or Windows-only dependencies.
go get github.com/radix29/gosmo
Go version note: The module requires Go 1.27
Architecture
The class map is split across five diagrams, one per area. It is one map,
not five — a single Mermaid diagram stops rendering above 50,000 characters
and the whole thing is well past that, so an edge that crosses areas is drawn
in the diagram of the area it points into (Server --> AvailabilityGroup
is in the high-availability one, where Server shows up as a bare box).
gosmo.mermaid holds the same five diagrams, concatenated in order, and is
kept byte-identical to what is below.
Connecting, the server, and logins
The entry point, authentication, server-level security and the login
object — plus the internal connection helpers every read and write goes
through, and the WithScript collector that can capture a write instead of
running it.
classDiagram
%% =========================================================
%% Top-level entry point
%% =========================================================
class ConnectionOptions {
+Server string
+Database string
+Auth AuthMethod
+User string
+Password string
+TenantID string
+ClientID string
+ClientCertPath string
+AccessToken string
+AccessTokenProvider func
+ServerSPN string
+Kerberos KerberosOptions
+ConnectTimeout Duration
+ApplicationName string
+MaxOpenConns int
+MaxIdleConns int
+ConnMaxLifetime Duration
+ConnMaxIdleTime Duration
+SessionInitSQL string
+TrustServerCertificate bool
+Encrypt string
}
class Server {
-db *sql.DB
-info *ServerInfo
+Connect(opts) *Server
+ConnectContext(ctx, opts) *Server
+NewServer(ctx, db) *Server
+ParseServerAddress(server) string
+Close() error
+DB() *sql.DB
+Info() *ServerInfo
+Name() string
+CurrentDatabase() string
+CurrentLogin() string
+Databases() []*Database
+DatabaseByName(name) *Database
+Database(name) *Database
+CreateDatabase(name, opts) error
+DropDatabase(name, force) error
+RenameDatabase(oldName, newName, force) error
+Logins() []*Login
+LoginByName(name) *Login
+Login(name) *Login
+CreateLogin(name, password, opts) error
+DropLogin(name) error
+ServerRoles() []*ServerRole
+ServerRoleByName(name) *ServerRole
+DropServerRole(name) error
+ServerRoleMembers(role) []*RoleMember
+AddServerRoleMember(role, member) error
+RemoveServerRoleMember(role, member) error
+LinkedServers() []*LinkedServer
+Configurations() []*Configuration
+AgentInfo() *AgentStatus
+Jobs() []*Job
+JobByName(name) *Job
+Job(name) *Job
+CreateJob(req) *Job
+JobHistory(limit) []*JobHistoryEntry
+Alerts() []*Alert
+EventAlerts() []*Alert
+AlertByName(name) *Alert
+Alert(name) *Alert
+CreateAlert(req) *Alert
+Operators() []*Operator
+OperatorByName(name) *Operator
+Operator(name) *Operator
+CreateOperator(req) *Operator
+Schedules() []*Schedule
+ScheduleByName(name) *Schedule
+Schedule(name) *Schedule
+CreateSchedule(req) *Schedule
+Categories(class) []*Category
+CreateCategory(class, name) error
+DeleteCategory(class, name) error
+ActiveSessions(sys) []*Session
+KillSession(id) error
+EnumErrorLogs(logType) []*ErrorLogFile
+ReadLog(logType, n) []*ErrorLogEntry
+ReadLogFiltered(logType, n, search) []*ErrorLogEntry
+ReadErrorLog(n) []*ErrorLogEntry
+CycleLog(logType) error
+CycleErrorLog() error
+EnumFileSystem(path) []*FileSystemEntry
+EnumFileSystemIsLegacy() bool
+FixedDrives() []*FixedDrive
+FileSystemExists(path) bool
+MailProfiles() []*MailProfile
+SendMail(opts) error
+Backup(opts) error
+Restore(opts) error
+VerifyBackup(device) error
+BackupHeaders(device) []*BackupHeader
+BackupFileList(device) []*BackupFile
+BackupFileListForSet(device, fileNumber) []*BackupFile
+DatabaseRecoveryStatuses() []*DatabaseRecoveryStatus
+Capabilities() *Capabilities
+SecurityInfo() *ServerSecurityInfo
+ServerPermissions() []*ServerPermissionEntry
+GrantServerPermissionWithOptions(perm, principal, opts) error
+DenyServerPermissionWithOptions(perm, principal, opts) error
+RevokeServerPermissionWithOptions(perm, principal, opts) error
+EffectiveServerPermissions(login) []*EffectivePermission
+GrantServerPermission(perm, principal) error
+DenyServerPermission(perm, principal) error
+RevokeServerPermission(perm, principal) error
+ServerPermissionNames() []string
+Credentials() []*Credential
+MemoryStats() *ServerMemoryStats
+Languages() []*Language
+ProcessorInfo() *ProcessorInfo
+DiskVolumes() []DiskVolumeInfo
+AvailabilityGroups() []*AvailabilityGroup
+AvailabilityGroupByName(name) *AvailabilityGroup
+AvailabilityGroup(name) *AvailabilityGroup
+CreateAvailabilityGroup(req) *AvailabilityGroup
+DatabaseMirroringEndpoint() *DatabaseMirroringEndpoint
+CreateDatabaseMirroringEndpoint(spec) *DatabaseMirroringEndpoint
}
class ServerInfo {
+Name string
+Edition string
+ProductVersion string
+ProductLevel string
+Collation string
+IsClustered bool
+IsHADREnabled bool
+IsSingleUser bool
+EngineEdition int
+OSVersion string
+Platform string
+PhysicalMemoryMB int64
+LogicalCPUCount int
+SysInfoUnavailable bool
+DefaultDataPath string
+DefaultLogPath string
+DefaultBackupPath string
+VersionMajor int
+VersionMinor int
+VersionBuild int
}
%% =========================================================
%% Authentication
%% =========================================================
class AuthMethod {
<<enumeration>>
AuthSQLServer
AuthWindows
AuthEntraMSI
AuthEntraServicePrincipal
AuthEntraPassword
AuthEntraInteractive
AuthEntraDeviceCode
AuthEntraDefault
AuthEntraAzCLI
AuthEntraAzurePipelines
AuthEntraServicePrincipalAccessToken
AuthEntraOnBehalfOf
}
class KerberosOptions {
+ConfigFile string
+CredCacheFile string
+KeytabFile string
+Realm string
+DNSLookupKDC *bool
+UDPPreferenceLimit int
Native SSPI on Windows, unless set.
Every other platform authenticates
AuthWindows via Kerberos, using this or
the ambient kinit cache when it is the
zero value.
}
%% =========================================================
%% Server security, permissions, memory, languages
%% =========================================================
class ServerSecurityInfo {
+AuthenticationMode string
}
class ServerPermissionEntry {
+Principal string
+PrincipalType string
+Grantor string
+Permission string
+State string
}
class Credential {
+Name string
+Identity string
+CreateDate time.Time
+ModifyDate time.Time
}
class ServerMemoryStats {
+PhysicalMemoryMB int64
+AvailableMemoryMB int64
+TargetServerMemoryMB int64
+TotalServerMemoryMB int64
}
class Language {
+LangID int
+Name string
+Alias string
}
class ProcessorInfo {
+CPUCount int
+HyperthreadRatio int
+NUMANodeCount int
+CPUNUMANode []int
}
class DiskVolumeInfo {
+MountPoint string
+VolumeName string
+SamplePath string
+TotalMB float64
+AvailableMB float64
}
%% =========================================================
%% Login
%% =========================================================
class Login {
+Name string
+SID []byte
+LoginType string
+IsDisabled bool
+DefaultDatabase string
+CreateDate time.Time
+ModifyDate time.Time
+MappedObject string
+ResolveMapping() error
+Enable() error
+Disable() error
+ChangePassword(newPassword) error
+ChangePasswordWithOptions(pw, mustChange, unlock) error
+AddServerRoleMember(role) error
+RemoveServerRoleMember(role) error
+Drop() error
+Details() *LoginDetails
+Rename(newName) error
+SetDefaultDatabase(name) error
+SetDefaultLanguage(lang) error
+SetPasswordPolicy(checkPolicy, checkExpiration) error
+MapCredential(credential) error
+UnmapCredential(credential) error
+UserMappings() []*LoginUserMapping
+MapToDatabase(dbName, user, schema) error
+UnmapFromDatabase(dbName) error
}
class LoginDetails {
+IsLocked bool
+IsExpired bool
+MustChangePassword bool
+IsPolicyChecked bool
+IsExpirationChecked bool
+PasswordLastSet time.Time
+LastLogin time.Time
+BadPasswordCount int
+BadPasswordTime time.Time
+DefaultLanguage string
+CredentialName string
+ConnectSQLState string
}
class LoginUserMapping {
+Database string
+User string
+DefaultSchema string
+Roles []string
}
class nStringLiteral {
<<internal helper>>
Quotes a password as an N'...'
T-SQL string literal, escaping
any embedded quote.
Used by CreateLogin and ChangePassword —
HASHED is never used, since it tells
SQL Server the value is already one of
its own password-hash formats, not
cleartext.
}
%% =========================================================
%% Database
%% =========================================================
class Database {
-server *Server
-name string
-id int
-state string
-recoveryModel RecoveryModel
-compatLevel CompatibilityLevel
-collation string
-isReadOnly bool
-createDate time.Time
+Name() string
+ID() int
+State() string
+IsSystem() bool
+RecoveryModel() RecoveryModel
+CompatibilityLevel() CompatibilityLevel
+Tables() []*Table
+TablesBySchema(schema) []*Table
+TableByName(schema, name) *Table
+Table(schema, name) *Table
+CreateTable(req) error
+DropTable(schema, name, cascade) error
+RenameTable(schema, oldName, newName) error
+RenameObject(schema, oldName, newName) error
+Catalog() *Catalog
+SystemCatalog() *Catalog
+TablesFiltered(filter) []*Table
+TransferObject(targetSchema, schema, name) error
+Views() []*View
+ViewsFiltered(filter) []*View
+DropView(schema, name) error
+StoredProcedures() []*StoredProcedure
+StoredProceduresFiltered(filter) []*StoredProcedure
+CreateStoredProcedure(schema, name, body) error
+DropStoredProcedure(schema, name) error
+UserDefinedFunctions() []*UserDefinedFunction
+UserDefinedFunctionsFiltered(filter) []*UserDefinedFunction
+DropFunction(schema, name) error
+Parameters(schema, name) []*Parameter
+SystemViews() []*View
+SystemViewsFiltered(filter) []*View
+SystemStoredProcedures() []*StoredProcedure
+SystemStoredProceduresFiltered(filter) []*StoredProcedure
+SystemFunctions() []*UserDefinedFunction
+SystemFunctionsFiltered(filter) []*UserDefinedFunction
+Schemas() []*Schema
+SchemaByName(name) *Schema
+CreateSchema(name, owner) error
+DropSchema(name) error
+Users() []*User
+UserByName(name) *User
+CreateUser(user, login, schema) error
+DropUser(name) error
+DatabaseRoles() []*DatabaseRole
+RoleByName(name) *DatabaseRole
+DropDatabaseRole(name) error
+RoleMembers(role) []*RoleMember
+AddRoleMember(role, member) error
+RemoveRoleMember(role, member) error
+FileGroups() []*FileGroup
+Triggers() []*Trigger
+DropTrigger(schema, name) error
+Sequences() []*Sequence
+DropSequence(schema, name) error
+Synonyms() []*Synonym
+DropSynonym(schema, name) error
+PartitionFunctions() []*PartitionFunction
+PartitionFunctionByName(name) *PartitionFunction
+PartitionSchemes() []*PartitionScheme
+PartitionSchemeByName(name) *PartitionScheme
+ExtendedProperties(level) []*ExtendedProperty
+AddExtendedProperty(name, value, level) error
+SetExtendedProperty(name, value, level) error
+DropExtendedProperty(name, level) error
+Certificates() []*Certificate
+CertificateByName(name) *Certificate
+CreateCertificate(spec) error
+HasMasterKey() bool
+CreateMasterKey(password) error
+ColumnMasterKeys() []*ColumnMasterKey
+ColumnMasterKeyByName(name) *ColumnMasterKey
+CreateColumnMasterKeyWithSignature(name, provider, path, sig) error
+ColumnEncryptionKeys() []*ColumnEncryptionKey
+ColumnEncryptionKeyByName(name) *ColumnEncryptionKey
+CreateColumnEncryptionKey(name, values) error
+SecurityPolicies() []*SecurityPolicy
+SecurityPolicyByName(schema, name) *SecurityPolicy
+Capabilities() *DatabaseCapabilities
+RecoveryStatus() *DatabaseRecoveryStatus
+SpaceUsed() SpaceInfo
+TableRowCounts() map~int,int64~
+TableSpaceUsedAll() map~int,TableSpaceInfo~
+SetRecoveryModel(model) error
+SetCompatibilityLevel(level) error
+SetReadOnly(bool) error
+SetUserAccess(mode) error
+SetOffline() error
+SetOnline() error
+Options() *DatabaseOptions
+SetDatabaseOption(opt, value) error
+SetOwner(principal) error
+DatabaseScopedConfigs() []*DatabaseScopedConfig
+SetDatabaseScopedConfig(name, value, forSecondary) error
+QueryStore() *QueryStoreInfo
+SetQueryStoreOptions(opts) error
+FlushQueryStore() error
+ClearQueryStore() error
+Files() []*DatabaseFileInfo
+AddFile(spec) error
+AlterFile(name, m) error
+RemoveFile(name) error
+AddFileGroup(name) error
+RemoveFileGroup(name) error
+SetDefaultFileGroup(name) error
+SetFileGroupReadOnly(name, ro) error
+ChangeTracking() *ChangeTrackingInfo
+SetChangeTracking(info) error
+TableChangeTracking() []*TableChangeTracking
+TableChangeTrackingFor(schema, name) *TableChangeTracking
+SetTableChangeTracking(schema, name, enable, cols) error
+Dependencies(schema, name) []*Dependency
+Dependents(schema, name) []*Dependency
+Search(pattern) []*SearchResult
+FindSecurables(search) []SecurableRef
+ObjectColumns(schema, name) []*Column
+Permissions(schema, name) []*PermissionEntry
+GrantPermission(schema, name, perm, principal) error
+DenyPermission(schema, name, perm, principal) error
+RevokePermission(schema, name, perm, principal) error
+PermissionsForPrincipal(principal) []*PrincipalSecurable
+GrantPermissionWithOptions(schema, name, perm, principal, opts) error
+DenyPermissionWithOptions(schema, name, perm, principal, opts) error
+RevokePermissionWithOptions(schema, name, perm, principal, opts) error
+ColumnPermissions(schema, name) []*ColumnPermissionEntry
+ColumnPermissionsForPrincipal(principal) []*ColumnPermissionEntry
+GrantColumnPermission(schema, name, perm, cols, principal) error
+DenyColumnPermission(schema, name, perm, cols, principal) error
+RevokeColumnPermission(schema, name, perm, cols, principal) error
+GrantColumnPermissionWithOptions(schema, name, perm, cols, principal, opts) error
+DenyColumnPermissionWithOptions(schema, name, perm, cols, principal, opts) error
+RevokeColumnPermissionWithOptions(schema, name, perm, cols, principal, opts) error
+EffectivePermissions(principal) []*EffectivePermission
+EffectiveObjectPermissions(schema, name, principal) []*EffectivePermission
+EffectiveSchemaPermissions(schema, principal) []*EffectivePermission
+SchemaPermissions(schema) []*PermissionEntry
+GrantSchemaPermission(schema, perm, principal) error
+DenySchemaPermission(schema, perm, principal) error
+RevokeSchemaPermission(schema, perm, principal) error
+GrantSchemaPermissionWithOptions(schema, perm, principal, opts) error
+DenySchemaPermissionWithOptions(schema, perm, principal, opts) error
+RevokeSchemaPermissionWithOptions(schema, perm, principal, opts) error
+DatabasePermissions() []*DatabasePermissionEntry
+GrantDatabasePermission(perm, principal) error
+DenyDatabasePermission(perm, principal) error
+RevokeDatabasePermission(perm, principal) error
+GrantDatabasePermissionWithOptions(perm, principal, opts) error
+DenyDatabasePermissionWithOptions(perm, principal, opts) error
+RevokeDatabasePermissionWithOptions(perm, principal, opts) error
+EstimatedPlan(sql) *ExecutionPlan
+ActualPlan(sql) *ExecutionPlan
+ExecProc(schema, name, params) ProcResult
+BulkInsert(bc, rows) int64
}
%% =========================================================
%% Connection helpers (internal)
%% =========================================================
class withConn {
<<internal helper>>
Acquires *sql.Conn from pool.
Executes USE db, retried on a
transient failure. Runs callback
fn(*sql.Conn) — NOT retried, since
fn is the caller's actual write.
Releases conn via defer.
Used by Database.exec.
}
class dbRows {
<<internal type>>
-Rows *sql.Rows
-conn *sql.Conn
+Close() error
Closes Rows then the conn pinned
for them. *sql.Rows.Close alone
leaves the conn checked out of the
pool forever. Returned by
Database.query().
}
class DatabaseQueryRow {
<<internal helper>>
Database.queryRow(ctx, scan, q, args)
Acquires conn, runs USE, hands the row
to scan — all inside one retry unit.
scan must run inside it: QueryRowContext
never errors, only Scan does.
}
class ServerQuery {
<<internal helpers>>
Server.query(ctx, q, args)
Server.queryRow(ctx, scan, q, args)
Server.queryRowScan(ctx, q, args, dest)
Server-scoped counterparts, with no USE
to redo. queryRowScan is the bare-Scan
convenience over queryRow.
}
class withRetry {
<<internal helper>>
Generic retry wrapper for idempotent
reads only. 3 attempts, linear backoff
of attempt times 50ms. Used by every
query/queryRow helper above.
}
class IsRetryable {
<<package function>>
True for the driver's RetryableError, a
dropped pooled connection (ErrBadConn),
a net.Error, a corrupted TDS stream, a
connection-severing ServerError, or EOF
— including wrapped errors. Exported so
callers running their own statements can
make the same retry decision.
}
%% =========================================================
%% Quoting (shared identifier / literal escaping)
%% =========================================================
class Quoting {
<<package functions>>
+QuoteName(name) string
+QuoteLiteral(s) string
Backed by the driver's own TSQLQuoter,
so gosmo, its callers, and gossms share
one quoting implementation. The internal
quoteIdent helper delegates to QuoteName.
}
%% =========================================================
%% Errors
%% =========================================================
class ErrNotFound {
<<sentinel>>
The error every by-name lookup that
reports absence wraps, so errors.Is
separates "does not exist" from
"the lookup itself failed".
CertificateByName returns (nil, nil)
instead, and AgentStatus reports an
unreachable Agent as a value.
}
class SQLError {
+Number int32
+State uint8
+Class uint8
+Message string
+ServerName string
+ProcName string
+LineNo int32
+All []SQLError
+AsSQLError(err) *SQLError
+Header() string
+Error() string
+IsError() bool
}
%% =========================================================
%% What the connected login may do
%% =========================================================
class Capabilities {
+ServerRoles map~string,bool~
+ServerPermissions map~string,CapabilityState~
+Has(name) bool
+Allows(name) bool
+Permission(name) CapabilityState
+InServerRole(name) bool
+IsSysadmin() bool
+Probed() bool
Has is the test for offering something,
Allows the test for withholding it —
deliberately not opposites, because
withholding must fail open. Every
method is nil-safe.
}
class CapabilityState {
<<enumeration>>
CapabilityUnknown
CapabilityGranted
CapabilityDenied
HAS_PERMS_BY_NAME returns NULL without
raising for a permission the instance
does not define, so Unknown is not a
denial.
}
class LoginSource {
<<enumeration>>
LoginSourceAuto
LoginSourceSQL
LoginSourceWindows
LoginSourceExternalProvider
LoginSourceCertificate
LoginSourceAsymmetricKey
}
%% =========================================================
%% Scripting pending writes (dry-run)
%% =========================================================
class ScriptCollector {
-mu sync.Mutex
+Statements []string
+WithScript(ctx) *ScriptCollector
+Scripting(ctx) bool
Captures the exact statement(s) a set of
pending write calls would run, without
running them. Every write funnels through
Server.execContext or Database.exec, the
two chokepoints WithScript intercepts.
Bound parameters are substituted as
literals so a captured statement runs
standalone; ExecProc is captured as its
EXEC form. Scripting(ctx) reports whether
a context is one of these, so a caller
does not mirror a write the server never
saw into its own state.
Statements is mutex-guarded: one collector
may be shared across goroutines.
}
%% =========================================================
%% Relationships
%% =========================================================
ConnectionOptions --> AuthMethod : uses
ConnectionOptions --> KerberosOptions : configures AuthWindows via
Server --> ConnectionOptions : created from
Server --> ServerInfo : has
Server "1" --> "*" Database : owns
Server "1" --> "*" Login : owns
Server "1" --> "*" ServerRole : owns
Server "1" --> "*" RoleMember : ServerRoleMembers() returns
Server "1" --> "*" LinkedServer : owns
Server --> ServerSecurityInfo : has
Server "1" --> "*" ServerPermissionEntry : grants
Server "1" --> "*" Credential : owns
Server --> ServerMemoryStats : has
Server "1" --> "*" Language : lists
Server --> ProcessorInfo : has
Server "1" --> "*" DiskVolumeInfo : lists
Server --> Capabilities : Capabilities() returns
Capabilities --> CapabilityState : answers with
DatabaseCapabilities --> CapabilityState : answers with
Login ..> nStringLiteral : password quoted by
Login --> LoginDetails : has
Login "1" --> "*" LoginUserMapping : mapped via
Login ..> LoginSource : created from
Database ..> withConn : writes run via
Database ..> dbRows : query() returns
Database ..> DatabaseQueryRow : single-row reads via
Database ..> withRetry : reads retried via
Server ..> ServerQuery : reads run via
Server ..> withRetry : reads retried via
withRetry <.. withConn : acquire+USE retried by
withRetry <.. dbRows : acquire+USE+query retried by
withRetry <.. DatabaseQueryRow : whole scan retried by
withRetry <.. ServerQuery : whole scan retried by
withRetry <.. IsRetryable : same failure test as
ServerScripter ..> Server : scripts logins and server roles of
ScriptCollector ..> Server : captures writes from
ScriptCollector ..> Database : captures writes from
A database: files, options, catalog, and permissions
What Database exposes about itself — its files and filegroups, its
ALTER DATABASE options, change tracking, the bulk catalog snapshot, Query
Store, dependencies and search, and the whole permissions surface, including
column-level and effective permissions.
classDiagram
%% =========================================================
%% Database files, filegroups, and options
%% =========================================================
class DatabaseFileInfo {
+FileID int
+Name string
+PhysicalName string
+Type string
+FileGroup string
+State string
+SizeKB int64
+MaxSizeKB int64
+GrowthKB int64
+GrowthPercent int
+IsPercentGrowth bool
}
class DatabaseFileSpec {
+Name string
+FileGroup string
+Type string
+Path string
+SizeKB int64
+GrowthKB int64
+GrowthPercent int
+DisableGrowth bool
+MaxSizeKB int64
}
class FileModify {
+NewName string
+SizeKB int64
+GrowthKB int64
+GrowthPercent int
+DisableGrowth bool
+MaxSizeKB int64
DisableGrowth is FILEGROWTH = 0. Zero
cannot say it: GrowthKB = 0 means
"leave this property alone".
}
class DatabaseOptions {
+Owner string
+PageVerify string
+UserAccess string
+Containment string
+DefaultCursor string
+SnapshotIsolation string
+AutoClose bool
+AutoShrink bool
+AutoCreateStats bool
+AutoUpdateStats bool
+AutoUpdateStatsAsync bool
+ANSINullDefault bool
+ANSINulls bool
+ANSIPadding bool
+ANSIWarnings bool
+ArithAbort bool
+ConcatNullYieldsNull bool
+NumericRoundAbort bool
+QuotedIdentifier bool
+RecursiveTriggers bool
+CursorCloseOnCommit bool
+ReadCommittedSnapshot bool
+IsTrustworthy bool
+IsBrokerEnabled bool
}
%% =========================================================
%% Change tracking
%% =========================================================
class ChangeTrackingInfo {
+Enabled bool
+AutoCleanup bool
+RetentionPeriod int
+RetentionUnit string
}
class TableChangeTracking {
+Schema string
+Name string
+Enabled bool
+TrackColumnsUpdated bool
}
%% =========================================================
%% Catalog snapshot (bulk table/view + column inventory)
%% =========================================================
class Catalog {
+Schemas []string
+Objects []CatalogObject
}
class CatalogObject {
+ObjectID int
+Schema string
+Name string
+Type CatalogObjectType
+Columns []CatalogColumn
}
class CatalogColumn {
+Name string
+DataType DataType
+MaxLength int
+Precision int
+Scale int
+IsNullable bool
}
%% =========================================================
%% Query Store and Database Scoped Configuration
%% =========================================================
class QueryStoreInfo {
+DesiredState string
+ActualState string
+ReadOnlyReason int
+CurrentStorageMB int64
+MaxStorageMB int64
+CaptureMode string
+SizeCleanupMode string
+StaleThresholdDays int
+WaitStatsCaptureMode string
}
class DatabaseScopedConfig {
+ID int
+Name string
+Value string
+ValueForSecondary string
+IsValueDefault bool
}
%% =========================================================
%% Dependencies and object search
%% =========================================================
class Dependency {
+Schema string
+Name string
+TypeDesc string
+IsSchemaBound bool
}
class SearchResult {
+Schema string
+Name string
+TypeDesc string
}
%% =========================================================
%% Narrowing a listing at the server
%% =========================================================
class ObjectFilter {
+Name []TextCriterion
+Schema []TextCriterion
+Created []DateCriterion
+MemoryOptimized *bool
+Empty() bool
Criteria are AND-ed; a zero filter
narrows nothing. Matching lowercases
both sides, because a bare LIKE follows
the database collation, and the pattern
is escaped, because %, _ and [ are legal
in an identifier.
}
class TextCriterion {
+Op TextOp
+Value string
}
class DateCriterion {
+Op DateOp
+Day time.Time
}
class TextOp {
<<enumeration>>
TextContains
TextNotContains
TextEquals
TextNotEquals
}
class DateOp {
<<enumeration>>
DateOn
DateBefore
DateAfter
All three compare whole calendar days.
}
%% =========================================================
%% Procedure and function parameters
%% =========================================================
class Parameter {
+Name string
+Ordinal int
+DataType DataType
+MaxLength int
+Precision int
+Scale int
+IsOutput bool
+HasDefault bool
+TypeString() string
sys.parameters for one procedure or
function. A scalar function's return
value, stored there as parameter_id 0,
is not a parameter and is not returned.
}
%% =========================================================
%% What the connected login may do here
%% =========================================================
class DatabaseCapabilities {
+Accessible bool
+Roles map~string,bool~
+Permissions map~string,CapabilityState~
+Has(name) bool
+Allows(name) bool
+Permits(name) bool
+Permission(name) CapabilityState
+InRole(name) bool
Accessible is HAS_DBACCESS: check it
before expanding a database at all.
Permits is Allows plus that, since an
inaccessible database answers Unknown
to every permission.
}
class DatabaseRecoveryStatus {
+DatabaseName string
+LastLogBackupLSN string
+LogBackupChainStarted bool
Whether the log backup chain has been
started at all — what SQL Server tests
before a database may join an
availability group.
}
%% =========================================================
%% Execution plans
%% =========================================================
class ExecutionPlan {
+XML string
+All []string
A batch of several statements yields
several plan documents. XML is the last
of them; All holds every one.
}
%% =========================================================
%% Object and database-scoped permissions
%% =========================================================
class PermissionEntry {
+Principal string
+PrincipalType string
+Grantor string
+Permission ObjectPermission
+State PermissionState
}
class DatabasePermissionEntry {
+Principal string
+PrincipalType string
+Grantor string
+Permission string
+State string
}
class PrincipalSecurable {
+SecurableType string
+Schema string
+Name string
+Permission string
+State string
}
class ColumnPermissionEntry {
+Principal string
+PrincipalType string
+Grantor string
+Schema string
+Object string
+ObjectType string
+Column string
+Permission ObjectPermission
+State PermissionState
}
class EffectivePermission {
+Entity string
+Subentity string
+Permission string
}
class PermissionOptions {
+WithGrantOption bool
+Cascade bool
+GrantOptionOnly bool
}
class SecurableSearch {
+Name string
+Limit int
}
class SecurableRef {
+Type string
+Schema string
+Name string
}
%% =========================================================
%% Bulk copy (fast import — bcp / SSMS "Import Data")
%% =========================================================
class BulkCopy {
+Schema string
+Table string
+Columns []string
+Options BulkOptions
+SliceRows(rows) iter.Seq2
}
class BulkOptions {
+CheckConstraints bool
+FireTriggers bool
+KeepNulls bool
+TableLock bool
+RowsPerBatch int
+KilobytesPerBatch int
+Order []string
}
%% =========================================================
%% Stored-procedure execution
%% =========================================================
class ProcParam {
+In(name, value) ProcParam
+Out(name, dest) ProcParam
+InOut(name, dest) ProcParam
}
class ProcResult {
+ReturnStatus int32
}
%% =========================================================
%% Relationships
%% =========================================================
Database "1" --> "*" DatabaseFileInfo : contains
Database "1" --> "*" FileGroup : contains
Database --> DatabaseOptions : has
Database --> ChangeTrackingInfo : has
Database "1" --> "*" TableChangeTracking : tracks
Database --> Catalog : Catalog()/SystemCatalog() returns
Catalog "1" --> "*" CatalogObject : contains
CatalogObject "1" --> "*" CatalogColumn : has
Database --> QueryStoreInfo : has
Database "1" --> "*" DatabaseScopedConfig : lists
Database "1" --> "*" Dependency : dependencies of
Database "1" --> "*" SearchResult : search() returns
Database "1" --> "*" Parameter : Parameters() returns
Database --> DatabaseRecoveryStatus : RecoveryStatus() returns
Database --> DatabaseCapabilities : Capabilities() returns
Database ..> ObjectFilter : ...Filtered() listings narrowed by
ObjectFilter --> TextCriterion : matches names and schemas with
ObjectFilter --> DateCriterion : matches creation dates with
TextCriterion --> TextOp : uses
DateCriterion --> DateOp : uses
Database --> ExecutionPlan : produces
Database "1" --> "*" PermissionEntry : grants
Database "1" --> "*" DatabasePermissionEntry : grants
Database "1" --> "*" PrincipalSecurable : PermissionsForPrincipal() returns
Database "1" --> "*" ColumnPermissionEntry : ColumnPermissions() returns
Database "1" --> "*" EffectivePermission : EffectivePermissions() returns
Database "1" --> "*" SecurableRef : FindSecurables() returns
SecurableSearch ..> SecurableRef : narrows FindSecurables()
Database ..> BulkCopy : bulk-loads via
Database ..> ProcParam : executes procs with
Database --> ProcResult : returns
Tables, their children, and the object families
Table and everything hanging off it (columns, indexes, foreign keys,
constraints, statistics, partitions), the other object families a database
contains, and the Scripter that generates CREATE DDL for any of them.
classDiagram
%% =========================================================
%% Table and its children
%% =========================================================
class Table {
+ObjectID int
+Schema string
+Name string
+CreateDate time.Time
+ModifyDate time.Time
+HasReplicationFilter bool
+IsMemoryOptimized bool
+FullName() string
+Columns() []*Column
+Indexes() []*Index
+IndexByName(name) *Index
+XMLIndexes() []*XMLIndex
+ForeignKeys() []*ForeignKey
+ForeignKeyByName(name) *ForeignKey
+CheckConstraints() []*CheckConstraint
+Statistics() []*Statistic
+StatisticByName(name) *Statistic
+Partitions() []*Partition
+Triggers() []*Trigger
+DataSpace() DataSpace
+RowCount() int64
+CountWhere(predicate) int64
+CheckWhereSyntax(predicate) error
+Detail() *TableDetail
+SpaceUsed() *TableSpaceInfo
+TruncateTable() error
+FragmentationStats(mode) []*IndexFragmentation
+RebuildAllIndexes(fillFactor) error
+UpdateAllStatistics(samplePct) error
+CreateIndex(req) error
+CreateStatistic(name, cols, pct) error
+CreateStatisticWithOptions(req) error
+AlterColumn(col) error
+DropColumn(name) error
+RenameColumn(name, newName) error
+DropConstraint(name) error
}
class Column {
+Name string
+OrdinalPosition int
+DataType DataType
+MaxLength int
+Precision int
+Scale int
+IsNullable bool
+IsIdentity bool
+IdentitySeed int64
+IdentityIncrement int64
+IsComputed bool
+ComputedText string
+DefaultValue *ColumnDefault
+IsRowGUID bool
+IsPrimaryKey bool
+Collation string
}
class Index {
+Name string
+IndexID int
+Type IndexType
+IsClustered bool
+IsUnique bool
+IsPrimaryKey bool
+IsDisabled bool
+FillFactor int
+IsPadded bool
+IgnoreDupKey bool
+AllowRowLocks bool
+AllowPageLocks bool
+DataCompression string
+KeyColumns []IndexColumn
+IncludedColumns []IndexColumn
+FilterDefinition string
+DataSpace DataSpace
+Rebuild(t, fillFactor) error
+RebuildWithOptions(t, fillFactor, padIndex, compression) error
+Reorganize(t) error
+Disable(t) error
+Enable(t) error
+Rename(t, newName) error
+SetOptions(t, ignoreDupKey, rowLocks, pageLocks) error
+SetLockOptions(t, rowLocks, pageLocks) error
+SetIncludedColumns(t, columns) error
+UpdateStatistics(t) error
+StorageInfo(t) *IndexStorageInfo
+Fragmentation(t, mode) *IndexFragmentation
+Drop(t) error
+Type.IsColumnStore() bool
Type is a sys.indexes type_desc value; an
unrecognized one is carried through as the
server's own text. IsColumnStore covers
both columnstore forms, neither of which
SetIncludedColumns supports.
}
class IndexStorageInfo {
+FileGroup string
+PartitionScheme string
+PartitionColumn string
+RowCount int64
+UsedKB int64
+ReservedKB int64
+AvgRecordSize float64
+Allocations []IndexAllocationUnit
}
class IndexAllocationUnit {
+Type string
+Pages int64
+UsedKB int64
}
class IndexFragmentation {
+IndexName string
+IndexID int
+AvgFragmentationPct float64
+PageCount int64
+FragmentCount int64
+AvgPageSpaceUsedPct float64
}
class CreateIndexRequest {
+Name string
+Type IndexType
+IsUnique bool
+KeyColumns []IndexColumnDef
+IncludedColumns []string
+FilterDefinition string
+FillFactor int
+PadIndex bool
+Online bool
+SortInTempDB bool
+DropExisting bool
+DataCompression string
+CompressionDelay int
+FileGroup string
+PartitionScheme string
+PartitionColumns []string
+IsPrimaryXML bool
+PrimaryXMLIndex string
+SecondaryXMLType XMLSecondaryIndexType
+Tessellation SpatialTessellation
+BoundingBox *SpatialBoundingBox
+GridLevels SpatialGridLevels
+CellsPerObject int
Which fields apply depends on Type.
A combination the server would reject
is refused before anything runs, with
an error naming the field.
}
class XMLIndex {
+Name string
+IndexID int
+IsPrimary bool
+SecondaryType XMLSecondaryIndexType
+ColumnName string
+PrimaryIndexName string
What sys.indexes cannot say: primary or
secondary, which form, and over which
primary index it is built.
}
class XMLSecondaryIndexType {
<<enumeration>>
XMLSecondaryPath
XMLSecondaryValue
XMLSecondaryProperty
}
class SpatialTessellation {
<<enumeration>>
SpatialGeometryGrid
SpatialGeometryAutoGrid
SpatialGeographyGrid
SpatialGeographyAutoGrid
+IsGeometry() bool
+IsAutoGrid() bool
}
class SpatialBoundingBox {
+XMin float64
+YMin float64
+XMax float64
+YMax float64
Belongs around the data, not around the
coordinate system: anything outside it
lands in the single top-level cell.
}
class SpatialGridLevels {
+Level1 SpatialGridDensity
+Level2 SpatialGridDensity
+Level3 SpatialGridDensity
+Level4 SpatialGridDensity
}
class SpatialGridDensity {
<<enumeration>>
SpatialGridLow
SpatialGridMedium
SpatialGridHigh
}
class DataSpace {
+Name string
+IsPartitionScheme bool
+IsDefaultFileGroup bool
+PartitionColumn string
Where a table or index keeps its rows —
CREATE TABLE / CREATE INDEX's ON clause.
}
class ForeignKey {
+Name string
+Columns []string
+ReferencedTable string
+ReferencedSchema string
+ReferencedColumns []string
+DeleteAction string
+UpdateAction string
+IsDisabled bool
}
class CheckConstraint {
+Name string
+Definition string
+IsDisabled bool
+Column string
}
class Statistic {
+Name string
+StatID int
+IsAutoCreated bool
+IsUserCreated bool
+HasFilter bool
+FilterDef string
+LastUpdated time.Time
+RowsSampled int64
+TotalRows int64
+Steps int
+UnfilteredRows int64
+NoRecompute bool
+IsIncremental bool
+ModificationCounter int64
+Columns() []string
+Header() *StatisticHeader
+DensityVector() []*StatisticDensity
+Histogram() []*StatisticHistogramStep
+Update(samplePct) error
+Drop() error
+Rename(newName) error
}
class CreateStatisticRequest {
+Name string
+Columns []string
+SamplePercent int
+FullScan bool
+FilterDefinition string
+NoRecompute bool
+Incremental bool
}
class StatisticHeader {
+Updated string
+Rows int64
+RowsSampled int64
+Steps int
+Density float64
+AverageKeyLength float64
+StringIndex string
+FilterExpression string
+UnfilteredRows int64
+PersistedSamplePercent float64
}
class StatisticDensity {
+AllDensity float64
+AverageLength float64
+Columns string
}
class StatisticHistogramStep {
+RangeHighKey string
+RangeRows float64
+EqRows float64
+DistinctRangeRows int64
+AvgRangeRows float64
}
class TableDetail {
+SchemaOwner string
+LockEscalation string
+UsesAnsiNulls bool
+IsReplicated bool
+IsTrackedByCDC bool
+TemporalType string
+Durability string
+LedgerType string
+PrimaryKeyName string
+DataSpace string
}
class TableSpaceInfo {
+ReservedKB int64
+DataKB int64
+IndexKB int64
+LOBKB int64
+UnusedKB int64
+FileGroup string
}
%% =========================================================
%% Scripter (generates CREATE DDL for existing objects — distinct
%% from ScriptCollector, which captures pending write statements)
%% =========================================================
class Scripter {
-db *Database
-opts ScriptOptions
+NewScripter(db, opts) *Scripter
+ScriptTable(schema, name) string
+ScriptView(schema, name) string
+ScriptStoredProcedure(schema, name) string
+ScriptFunction(schema, name) string
+ScriptTrigger(schema, name) string
+ScriptIndex(schema, table, name) string
+ScriptCheckConstraint(schema, table, name) string
+ScriptForeignKey(schema, table, name) string
+ScriptSequence(schema, name) string
+ScriptSynonym(schema, name) string
+ScriptSchema(name) string
+ScriptUser(name) string
+ScriptDatabaseRole(name) string
+ScriptPartitionFunction(name) string
+ScriptPartitionScheme(name) string
+ScriptSecurityPolicy(schema, name) string
+ScriptColumnMasterKey(name) string
+ScriptColumnEncryptionKey(name) string
+ScriptDatabase() string
+ScriptSelect(schema, name) string
+ScriptInsert(schema, name) string
+ScriptUpdate(schema, name) string
+ScriptDelete(schema, name) string
+ScriptExecute(schema, name) string
+ScriptFunctionCall(schema, name, funcType) string
}
class ServerScripter {
-server *Server
-opts ScriptOptions
+NewServerScripter(server, opts) *ServerScripter
+ScriptLogin(name) string
+ScriptServerRole(name) string
}
class ScriptVerb {
<<enumeration>>
ScriptCreate
ScriptDrop
ScriptDropAndCreate
ScriptAlter
ScriptAlter applies to module objects —
view, procedure, function, trigger —
and everything else falls back to CREATE.
}
class ScriptOptions {
+Verb ScriptVerb
+IncludeHeaders bool
+IncludeIfNotExists bool
+ScriptDrops bool
+SchemaQualify bool
+AnsiPadding bool
}
%% =========================================================
%% Database objects
%% =========================================================
class Schema {
+Name string
+ID int
+Owner string
+ObjectCount() int
+ObjectCountsByType() SchemaObjectCounts
+ChangeOwner(newOwner) error
+Drop() error
}
class SchemaObjectCounts {
+Tables int
+Views int
+StoredProcedures int
+Functions int
+Synonyms int
+Sequences int
Each count reproduces the predicate of
the listing it stands in for, which is
why it does not add up to ObjectCount's
single COUNT over sys.objects.
}
class View {
+ObjectID int
+Schema string
+Name string
+Definition string
+CreateDate time.Time
+ModifyDate time.Time
}
class StoredProcedure {
+ObjectID int
+Schema string
+Name string
+Definition string
+CreateDate time.Time
+ModifyDate time.Time
}
class UserDefinedFunction {
+ObjectID int
+Schema string
+Name string
+FuncType string
+Definition string
+CreateDate time.Time
+ModifyDate time.Time
}
class User {
+Name string
+ID int
+UserType string
+DefaultSchema string
+AuthType string
+CreateDate time.Time
+ModifyDate time.Time
+SID []byte
+LoginName string
+LoginDisabled bool
+Rename(newName) error
+SetDefaultSchema(schemaName) error
+SetLogin(loginName) error
}
class DatabaseRole {
+Name string
+ID int
+IsFixedRole bool
+Owner string
+Members []string
+SID []byte
+CreateDate time.Time
+ModifyDate time.Time
+Rename(newName) error
+Drop() error
+ChangeOwner(newOwner) error
}
class RoleMember {
+Name string
+Type string
}
class FileGroup {
+Name string
+IsDefault bool
+IsReadOnly bool
+Files []DatabaseFile
}
class Trigger {
+Name string
+TableName string
+Schema string
+IsEnabled bool
+Events []string
+Definition string
}
class ServerRole {
+ID int
+Name string
+IsFixedRole bool
+Owner string
+SID []byte
+CreateDate time.Time
+ModifyDate time.Time
+Members []string
+Rename(newName) error
+Drop() error
+ChangeOwner(newOwner) error
}
class LinkedServer {
+Name string
+Product string
+Provider string
+DataSource string
+IsRemote bool
}
%% =========================================================
%% Relationships
%% =========================================================
Database "1" --> "*" Table : contains
Database "1" --> "*" View : contains
Database "1" --> "*" StoredProcedure : contains
Database "1" --> "*" UserDefinedFunction : contains
Database "1" --> "*" Schema : contains
Database "1" --> "*" User : contains
Database "1" --> "*" DatabaseRole : contains
Database "1" --> "*" Trigger : contains
Database "1" --> "*" RoleMember : RoleMembers() returns
Database "1" --> "*" Column : ObjectColumns() returns (table or view)
Table "1" --> "*" Column : has
Table "1" --> "*" Index : has
Table "1" --> "*" ForeignKey : has
Table "1" --> "*" CheckConstraint : has
Table "1" --> "*" Statistic : has
Table "1" --> "*" Trigger : has
Table --> TableDetail : has
Table --> TableSpaceInfo : has
Table "1" --> "*" IndexFragmentation : FragmentationStats() returns
Table "1" --> "*" XMLIndex : XMLIndexes() returns
Table --> DataSpace : DataSpace() returns
Table ..> CreateIndexRequest : CreateIndex() takes
Table ..> CreateStatisticRequest : CreateStatisticWithOptions() takes
Index --> IndexStorageInfo : StorageInfo() returns
IndexStorageInfo "1" --> "*" IndexAllocationUnit : breaks down into
Index --> IndexFragmentation : Fragmentation() returns
Index --> DataSpace : read with the index
CreateIndexRequest --> XMLSecondaryIndexType : XML form selected by
CreateIndexRequest --> SpatialTessellation : spatial scheme selected by
CreateIndexRequest --> SpatialBoundingBox : geometry schemes bounded by
CreateIndexRequest --> SpatialGridLevels : grid density set by
SpatialGridLevels --> SpatialGridDensity : per level
XMLIndex --> XMLSecondaryIndexType : secondary form
Schema --> SchemaObjectCounts : ObjectCountsByType() returns
Statistic --> StatisticHeader : Header() returns
Statistic "1" --> "*" StatisticDensity : DensityVector() returns
Statistic "1" --> "*" StatisticHistogramStep : Histogram() returns
Scripter --> Database : scripts objects from
Scripter --> ScriptOptions : configured by
ServerScripter --> ScriptOptions : configured by
ScriptOptions --> ScriptVerb : statement form selected by
Backup, restore, and SQL Server Agent
Backup and restore options and the metadata read back off a device, and the whole Agent node — jobs and their steps and history, alerts, operators, shared schedules, and categories.
classDiagram
%% =========================================================
%% Backup / Restore
%% =========================================================
class BackupOptions {
+Database string
+Devices []string
+Action BackupAction
+Files []string
+FileGroups []string
+CopyOnly bool
+Compression bool
+Checksum bool
+Description string
+Name string
+MediaName string
+Expiry time.Time
+RetainDays int
+BlockSize int
+BufferCount int
+MaxTransferSize int
+Stats int
+Init bool
+Format bool
+Progress func
+BuildBackupStatement(opts) string
}
class RestoreOptions {
+Database string
+Devices []string
+Action BackupAction
+Files []string
+FileGroups []string
+RelocateFiles []RelocateFile
+Recovery bool
+Replace bool
+Checksum bool
+Stats int
+StopAt time.Time
+StopAtMarkName string
+FileNumber int
+Progress func
+BuildRestoreStatement(opts) string
}
class BackupHeader {
+BackupName string
+Description string
+BackupType BackupAction
+Position int
+DatabaseName string
+BackupStart time.Time
+BackupFinish time.Time
+BackupSize int64
+Compressed bool
+HasChecksums bool
+IsCopyOnly bool
+RecoveryModel string
}
class BackupFile {
+LogicalName string
+PhysicalName string
+Type string
+FileGroupName string
+Size int64
+MaxSize int64
}
%% =========================================================
%% SQL Server Agent
%% =========================================================
class AgentStatus {
+Running bool
+StatusText string
+LastStartupTime time.Time
}
class Job {
+JobID string
+Name string
+Description string
+IsEnabled bool
+Category string
+OwnerLoginName string
+DateCreated time.Time
+DateModified time.Time
+StartStepID int
+DeleteLevel NotifyLevel
+NotifyLevelEmail NotifyLevel
+NotifyEmailOperatorName string
+LastRunDate time.Time
+LastRunOutcome JobOutcome
+LastRunDuration Duration
+NextRunDate time.Time
+CurrentState JobState
+Steps() []*JobStep
+AddStep(req) error
+InsertStep(req, stepID) error
+MoveStep(stepID, newStepID) error
+ReorderSteps(order) error
+Schedules() []*Schedule
+AddSchedule(req) error
+AttachSchedule(name) error
+DetachSchedule(name) error
+History(limit) []*JobHistoryEntry
+Start(stepName) error
+Stop() error
+Enable() error
+Disable() error
+Rename(newName) error
+SetDescription(desc) error
+SetCategory(category) error
+SetOwner(login) error
+SetStartStep(stepID) error
+SetDeleteLevel(level) error
+SetEmailNotify(operator, level) error
+Drop() error
}
class JobStep {
+StepID int
+Name string
+Subsystem string
+Command string
+Database string
+OnSuccessAction int
+OnSuccessStepID int
+OnFailAction int
+OnFailStepID int
+LastRunOutcome JobOutcome
+LastRunDate time.Time
+LastRunDuration int
+LastRunElapsed Duration
+RetryAttempts int
+RetryInterval int
+OutputFileName string
+Flags int
+ProxyName string
+AdditionalParameters string
+Server string
+DatabaseUserName string
+CmdExecSuccessCode int
+OSRunPriority int
+Update(req) error
+SetFlow(onSuccess, successStep, onFail, failStep) error
+Delete() error
The whole definition is carried because
a move is a delete and a re-insert —
msdb has no procedure that renumbers a
step in place.
}
class JobHistoryEntry {
+JobName string
+RunDate time.Time
+Duration Duration
+Outcome JobOutcome
+Message string
+StepID int
+StepName string
}
class Alert {
+ID int
+Name string
+Enabled bool
+EventSource string
+ErrorNumber int
+Severity int
+DatabaseName string
+DelayBetweenResponses Duration
+NotificationMessage string
+IncludeEventDescriptionIn int
+Category string
+JobName string
+PerformanceCondition string
+OccurrenceCount int
+LastOccurrence time.Time
+LastResponse time.Time
+IsEventAlert() bool
+Enable() error
+Disable() error
+Rename(newName) error
+SetTrigger(errorNumber, severity) error
+SetDatabase(dbName) error
+SetDelay(d) error
+SetNotificationMessage(msg) error
+SetJobResponse(jobName) error
+SetCategory(category) error
+Notifications() []*AlertNotification
+Notify(operator, method) error
+RemoveNotify(operator) error
+Drop() error
}
class AlertNotification {
+OperatorName string
+Method NotificationMethod
}
class Operator {
+ID int
+Name string
+Enabled bool
+EmailAddress string
+PagerAddress string
+NetSendAddress string
+Category string
+LastEmailDate time.Time
+LastPagerDate time.Time
+LastNetSendDate time.Time
+Enable() error
+Disable() error
+Rename(newName) error
+SetEmailAddress(addr) error
+SetCategory(category) error
+NotifyingAlerts() []*AlertNotificationRef
+NotifyingJobs() []*JobNotificationRef
+Drop() error
}
class AlertNotificationRef {
+AlertName string
+Method NotificationMethod
}
class JobNotificationRef {
+JobName string
+Level NotifyLevel
}
class Schedule {
+ID int
+Name string
+Enabled bool
+FreqType ScheduleFreqType
+FreqInterval int
+FreqSubdayType ScheduleSubdayType
+FreqSubdayInterval int
+FreqRelativeInterval int
+FreqRecurrenceFactor int
+ActiveStartDate time.Time
+ActiveEndDate time.Time
+ActiveStartTime int
+ActiveEndTime int
+OwnerLoginName string
+CreateDate time.Time
+ModifyDate time.Time
+Description() string
+Enable() error
+Disable() error
+Rename(newName) error
+SetOwner(login) error
+SetFrequency(f) error
+SetActiveRange(startDate, endDate, startTime, endTime) error
+Jobs() []*Job
+Drop() error
}
class ScheduleFrequency {
+FreqType ScheduleFreqType
+FreqInterval int
+FreqSubdayType ScheduleSubdayType
+FreqSubdayInterval int
+FreqRelativeInterval int
+FreqRecurrenceFactor int
}
class Category {
+ID int
+Class CategoryClass
+Name string
}
class ScheduleFreqType {
<<enumeration>>
FreqOnce
FreqDaily
FreqWeekly
FreqMonthly
FreqMonthlyRelative
FreqAutoStart
FreqOnIdle
}
class ScheduleSubdayType {
<<enumeration>>
SubdayOnce
SubdaySeconds
SubdayMinutes
SubdayHours
}
class NotificationMethod {
<<enumeration>>
NotifyMethodEmail
NotifyMethodPager
NotifyMethodNetSend
+String() string
}
class NotifyLevel {
<<enumeration>>
NotifyNever
NotifyOnSuccess
NotifyOnFailure
NotifyOnComplete
}
class CategoryClass {
<<enumeration>>
CategoryClassJob
CategoryClassAlert
CategoryClassOperator
}
%% =========================================================
%% Relationships
%% =========================================================
Server --> BackupOptions : accepts
Server --> RestoreOptions : accepts
Server "1" --> "*" BackupHeader : BackupHeaders() returns
Server "1" --> "*" BackupFile : BackupFileList() returns
Server --> AgentStatus : AgentInfo() returns
Server "1" --> "*" Job : owns
Server "1" --> "*" Alert : owns
Server "1" --> "*" Operator : owns
Server "1" --> "*" Schedule : owns
Server "1" --> "*" Category : owns
Server "1" --> "*" JobHistoryEntry : JobHistory() returns
Job "1" --> "*" JobStep : has
Job "1" --> "*" Schedule : attached to
Job "1" --> "*" JobHistoryEntry : History() returns
Job --> NotifyLevel : notified per
Schedule --> ScheduleFrequency : SetFrequency() accepts
Schedule --> ScheduleFreqType : recurs per
Schedule --> ScheduleSubdayType : repeats per
Alert "1" --> "*" AlertNotification : notifies via
Alert --> Job : responds by running
Operator "1" --> "*" AlertNotificationRef : notified by
Operator "1" --> "*" JobNotificationRef : emailed by
AlertNotification --> NotificationMethod : delivered by
Category --> CategoryClass : classified by
High availability and instance-level services
Always On availability groups with their replicas, databases and listeners; the database mirroring endpoint they ship log through; the certificates that authenticate it; and the two host-facing reads — the error log and the server's own filesystem.
classDiagram
%% =========================================================
%% Always On availability groups
%% =========================================================
class AvailabilityGroup {
-server *Server
+ID string
+Name string
+ResourceID string
+ResourceGroupID string
+ClusterType string
+AutomatedBackupPreference string
+FailureConditionLevel int
+HealthCheckTimeout int
+Version int
+BasicFeatures bool
+DTCSupport bool
+DBFailover bool
+IsDistributed bool
+IsContained bool
+RequiredSynchronizedSecondariesToCommit int
+PrimaryReplicaServerName string
+PrimaryRecoveryHealth string
+SynchronizationHealth string
+Server() *Server
+IsLocalPrimary() bool
+Replicas() []*AvailabilityReplica
+Databases() []*AvailabilityDatabase
+Listeners() []*AvailabilityGroupListener
+SetAutomatedBackupPreference(pref) error
+SetFailureConditionLevel(level) error
+SetHealthCheckTimeout(ms) error
+SetDBFailover(on) error
+SetDTCSupport(perDB) error
+SetRequiredSynchronizedSecondariesToCommit(n) error
+AddDatabase(name) error
+RemoveDatabase(name) error
+JoinDatabase(name) error
+UnjoinDatabase(name) error
+SuspendDatabase(name) error
+ResumeDatabase(name) error
+AddReplica(spec) error
+RemoveReplica(serverName) error
+AddListener(spec) error
+AddListenerIP(dnsName, ip) error
+SetListenerPort(dnsName, port) error
+RemoveListener(dnsName) error
+Join(clusterType) error
+GrantCreateAnyDatabase() error
+DenyCreateAnyDatabase() error
+Failover() error
+ForceFailoverAllowDataLoss() error
+Drop() error
}
class AvailabilityReplica {
+GroupID string
+GroupName string
+ReplicaID string
+ReplicaServerName string
+EndpointURL string
+AvailabilityMode string
+FailoverMode string
+SeedingMode string
+SessionTimeout int
+PrimaryRoleAllowConnections string
+SecondaryRoleAllowConnections string
+BackupPriority int
+ReadOnlyRoutingURL string
+IsLocal bool
+Role string
+OperationalState string
+ConnectedState string
+RecoveryHealth string
+SynchronizationHealth string
+LastConnectErrorNumber int
+LastConnectErrorDescription string
+LastConnectErrorTimestamp time.Time
+CreateDate time.Time
+ModifyDate time.Time
+ReadOnlyRoutingList() [][]string
+SetAvailabilityMode(mode) error
+SetFailoverMode(mode) error
+SetSeedingMode(mode) error
+SetPrimaryRoleAllowConnections(mode) error
+SetSecondaryRoleAllowConnections(mode) error
+SetSessionTimeout(seconds) error
+SetBackupPriority(priority) error
+SetReadOnlyRoutingURL(url) error
+SetReadOnlyRoutingList(list) error
+Drop() error
}
class AvailabilityDatabase {
+GroupID string
+ReplicaID string
+ReplicaServerName string
+DatabaseName string
+GroupDatabaseID string
+IsLocal bool
+IsPrimaryReplica bool
+SynchronizationState string
+SynchronizationHealth string
+DatabaseState string
+IsSuspended bool
+SuspendReason string
+LogSendQueueKB int64
+LogSendRateKBps int64
+RedoQueueKB int64
+RedoRateKBps int64
+SecondaryLagSeconds int64
+LastSentTime time.Time
+LastReceivedTime time.Time
+LastHardenedTime time.Time
+LastRedoneTime time.Time
+LastCommitTime time.Time
}
class AvailabilityGroupListener {
+GroupID string
+ListenerID string
+DNSName string
+Port int
+IsConformant bool
+IPConfigurationString string
+IsDistributedNetworkName bool
+IPAddresses []AvailabilityListenerIP
}
class AvailabilityListenerIP {
+IPAddress string
+SubnetMask string
+IsDHCP bool
+State string
}
class CreateAvailabilityGroupRequest {
+Name string
+ClusterType string
+AutomatedBackupPreference string
+FailureConditionLevel int
+HealthCheckTimeout int
+DBFailover bool
+DTCSupport bool
+RequiredSynchronizedSecondariesToCommit int
+Databases []string
+Replicas []AvailabilityReplicaSpec
+Listener *AvailabilityListenerSpec
}
class AvailabilityReplicaSpec {
+ServerName string
+EndpointURL string
+AvailabilityMode string
+FailoverMode string
+SeedingMode string
+SessionTimeout int
+BackupPriority int
+PrimaryRoleAllowConnections string
+SecondaryRoleAllowConnections string
+ReadOnlyRoutingURL string
}
class AvailabilityListenerSpec {
+DNSName string
+Port int
+DHCP bool
+DHCPSubnet string
+IPAddresses []AvailabilityListenerIPSpec
}
class AvailabilityListenerIPSpec {
+IPAddress string
+SubnetMask string
}
%% =========================================================
%% Database mirroring endpoint (Always On's transport)
%% =========================================================
class DatabaseMirroringEndpoint {
-server *Server
+Name string
+Port int
+State string
+Role string
+IsEncryptionEnabled bool
+EncryptionAlgorithm string
+ConnectionAuth string
+Owner string
+Server() *Server
+URL() string
+Start() error
+Stop() error
+Drop() error
+GrantConnect(login) error
}
class EndpointSpec {
+Name string
+Port int
+Role string
+Authentication string
+Encryption string
+EncryptionAlgorithm string
}
%% =========================================================
%% Certificates and the database master key
%% =========================================================
class Certificate {
-db *Database
+Name string
+CertificateID int
+PrincipalID int
+Subject string
+PvtKeyEncryptionType string
+StartDate time.Time
+ExpiryDate time.Time
+Thumbprint []byte
+HasPrivateKey() bool
+Encoded() []byte
+Drop() error
}
class CertificateSpec {
+Name string
+Authorization string
+Subject string
+StartDate time.Time
+ExpiryDate time.Time
+EncryptionPassword string
+FromBinary []byte
}
%% =========================================================
%% Error log
%% =========================================================
class ErrorLogType {
<<enumeration>>
ErrorLogSQLServer
ErrorLogAgent
}
class ErrorLogFile {
+Number int
+Date string
+LastWritten time.Time
+SizeBytes int64
}
class ErrorLogEntry {
+LogDate string
+Process string
+Text string
+Date time.Time
+ErrorLevel int
+Source() string
}
class LogSearch {
+Text1 string
+Text2 string
+From time.Time
+To time.Time
xp_readerrorlog's own arguments 3-6:
Text1 and Text2 are case-insensitive
substrings AND-ed together, not two
alternatives. A zero LogSearch reads
the whole file. Filtering at the server
is what makes the current log usable on
a busy instance.
}
%% =========================================================
%% Server filesystem (paths the SERVER resolves, not the client)
%% =========================================================
class FileSystemEntry {
+Name string
+FullPath string
+IsDirectory bool
+Size int64
+LastModified time.Time
}
class FixedDrive {
+Name string
+Type string
+FreeSpaceBytes int64
}
%% =========================================================
%% Relationships
%% =========================================================
Server "1" --> "*" AvailabilityGroup : AvailabilityGroups() returns
Server --> CreateAvailabilityGroupRequest : accepts
Server "1" --> "1" DatabaseMirroringEndpoint : has at most one
Server --> EndpointSpec : accepts
Server "1" --> "*" ErrorLogFile : EnumErrorLogs() returns
Server "1" --> "*" ErrorLogEntry : ReadLog() returns
Server "1" --> "*" FileSystemEntry : EnumFileSystem() returns
Server "1" --> "*" FixedDrive : FixedDrives() returns
Server ..> ErrorLogType : selects log family with
Server ..> LogSearch : ReadLogFiltered() narrowed by
AvailabilityGroup "1" --> "*" AvailabilityReplica : has
AvailabilityGroup "1" --> "*" AvailabilityDatabase : has
AvailabilityGroup "1" --> "*" AvailabilityGroupListener : has
AvailabilityGroup --> AvailabilityReplicaSpec : AddReplica() accepts
AvailabilityGroup --> AvailabilityListenerSpec : AddListener() accepts
AvailabilityGroupListener "1" --> "*" AvailabilityListenerIP : has
AvailabilityListenerSpec "1" --> "*" AvailabilityListenerIPSpec : has
CreateAvailabilityGroupRequest "1" --> "*" AvailabilityReplicaSpec : has
CreateAvailabilityGroupRequest --> AvailabilityListenerSpec : may have
AvailabilityReplica ..> DatabaseMirroringEndpoint : ships log through
Database "1" --> "*" Certificate : contains
Database --> CertificateSpec : CreateCertificate() accepts
Security
- Passwords are escaped, never spliced in raw.
CreateLogin,ChangePassword, andChangePasswordWithOptionsquote the password as anN'...'literal through the samenStringLiteralescaping every other string literal in the package uses, so it's injection-proof regardless of password content. - Connection lifetimes are correctly scoped.
Database.queryreturns a*dbRowsthat owns both the*sql.Rowsand the*sql.Connpinned to run itsUSE, closing both together —*sql.Rows.Closeon its own would leave that connection checked out of the pool for good. - Values that can't be parameterized are validated by shape or allowlist. DDL can't parameterize keyword or literal arguments, so anything spliced into one is checked first: recovery models, data types, and backup actions against their known sets; partition function boundary values against the shape of a well-formed SQL Server literal; Query Store mode keywords and index data-compression settings against their allowlists.
- One shared quoting implementation.
QuoteNameandQuoteLiteralwrap the driver's ownTSQLQuoter, so gosmo's internal identifier/literal escaping — and any caller or downstream consumer (e.g. gossms) building its own DDL — go through the same tested implementation rather than a hand-rolled one. - Permission and SET-option names are allowlisted, not interpolated.
GRANT/DENY/REVOKEandALTER DATABASE ... SETare DDL and can't parameterize their keyword arguments; every method that accepts one (GrantServerPermission,GrantPermission,GrantDatabasePermission,SetDatabaseOption, ...) rejects any name not on its allowlist instead of splicing caller input directly into the statement.
Packages
| Path | Purpose |
|---|---|
/ |
All SMO types and logic |
examples/ |
Nine runnable programs — see examples/README.md |
Quick start
import "github.com/radix29/gosmo"
srv, err := gosmo.Connect(gosmo.ConnectionOptions{
Server: "localhost:1433",
User: "sa",
Password: "YourPassword",
TrustServerCertificate: true,
})
if err != nil { log.Fatal(err) }
defer srv.Close()
fmt.Println(srv.Info().ProductVersion)
Connect opens the pool itself. Where the pool is not gosmo's to open — one
shared with the rest of an application, a driver wrapped for tracing or
retries, or a fake driver in a test — gosmo.NewServer(ctx, db) wraps an
existing *sql.DB and loads the same metadata. It is the inverse of
srv.DB(), and ownership passes to the Server, whose Close closes the
pool.
Feature map
Server
| SMO equivalent | gosmo |
|---|---|
Server.Databases |
srv.Databases() / srv.Database(name) (no-I/O handle) |
| Current database | srv.CurrentDatabase() |
Current login (SUSER_NAME()) |
srv.CurrentLogin() |
Server.Logins |
srv.Logins() / srv.LoginByName(name) / srv.Login(name) (no-I/O handle) |
Server.Roles |
srv.ServerRoles() / srv.ServerRoleByName(name) / srv.ServerRoleMembers(role) |
| Server role administration | role.Rename(newName) / role.ChangeOwner(owner) / srv.Add|RemoveServerRoleMember(role, member) |
| Drop a server role | srv.DropServerRole(name) / role.Drop() |
| Rename a database | srv.RenameDatabase(old, new, force) — force puts it in single-user mode first |
Server.LinkedServers |
srv.LinkedServers() |
Server.Configuration |
srv.Configurations() |
Server.JobServer (Agent) |
see SQL Server Agent below |
| Active sessions | srv.ActiveSessions(includeSystem) |
| Kill session | srv.KillSession(id) |
| Error log | srv.ReadLog(logType, n) / srv.ReadLogFiltered(logType, n, search) / srv.EnumErrorLogs(logType) / srv.CycleLog(logType) — see Error log |
| Database Mail | srv.MailProfiles() / srv.SendMail(...) |
| Create login (safe) | srv.CreateLogin(name, password, opts) — SQL, Windows, external provider, certificate or asymmetric key |
| Authentication mode | srv.SecurityInfo() |
| Server-level permissions | srv.ServerPermissions() / srv.Grant|Deny|RevokeServerPermission(...) / srv.ServerPermissionNames() |
| Server permissions with modifiers | srv.Grant|Deny|RevokeServerPermissionWithOptions(perm, principal, opts) — WITH GRANT OPTION, CASCADE, GRANT OPTION FOR |
| Effective server permissions | srv.EffectiveServerPermissions(login) (EXECUTE AS LOGIN + fn_my_permissions) |
| Credentials | srv.Credentials() |
| Live memory stats | srv.MemoryStats() |
| Languages | srv.Languages() |
| Processors / NUMA topology | srv.ProcessorInfo() |
| Disk volumes | srv.DiskVolumes() |
Server.EnumDirectories / EnumFiles |
srv.EnumFileSystem(path) / srv.FixedDrives() / srv.FileSystemExists(path) — see Server filesystem |
| Host OS family | srv.Info().Platform ("Windows" / "Linux", from @@VERSION) |
Server.AvailabilityGroups |
srv.AvailabilityGroups() / srv.AvailabilityGroup(name) (no-I/O handle) / srv.AvailabilityGroupByName(name) — see Always On |
| Database mirroring endpoint | srv.DatabaseMirroringEndpoint() / srv.CreateDatabaseMirroringEndpoint(spec) |
| Verify / inspect a backup device | srv.VerifyBackup(device) / srv.BackupHeaders(device) / srv.BackupFileList(device) |
| Log backup chain state | srv.DatabaseRecoveryStatuses() / db.RecoveryStatus() → *DatabaseRecoveryStatus |
| What may this login do? | srv.Capabilities() → *Capabilities — see Capabilities |
Wrap a *sql.DB you already have |
gosmo.NewServer(ctx, db) — the inverse of srv.DB() |
Database
| SMO equivalent | gosmo |
|---|---|
| Is a system database | db.IsSystem() |
Database.Tables |
db.Tables() / db.TablesBySchema(schema) |
| Bulk table/view + column snapshot | db.Catalog() (user objects) / db.SystemCatalog() (sys schema) |
Database.Views |
db.Views() / db.DropView(schema, name) |
Database.StoredProcedures |
db.StoredProcedures() |
Database.UserDefinedFunctions |
db.UserDefinedFunctions() / db.DropFunction(schema, name) |
| System Views/Procedures/Functions | db.SystemViews() / db.SystemStoredProcedures() / db.SystemFunctions() |
Database.Schemas |
db.Schemas() / db.SchemaByName(name) / schema.ObjectCount() / schema.ObjectCountsByType() |
Database.Users |
db.Users() / db.UserByName(name) |
| Database user administration | user.Rename(newName) / user.SetDefaultSchema(schemaName) / user.SetLogin(loginName) |
Database.Roles |
db.DatabaseRoles() / db.RoleByName(name) / db.RoleMembers(roleName) |
| Database role administration | role.Rename(newName) / role.ChangeOwner(newOwner) / role.Drop() / db.DropDatabaseRole(name) |
Database.FileGroups |
db.FileGroups() |
Database.Triggers |
db.Triggers() / db.DropTrigger(schema, name) |
Database.Sequences |
db.Sequences() / db.DropSequence(schema, name) |
Database.Synonyms |
db.Synonyms() / db.DropSynonym(schema, name) |
Rename any sp_rename-able object |
db.RenameObject(schema, oldName, newName) — view, procedure, function, sequence, synonym, trigger |
| Move an object to another schema | db.TransferObject(targetSchema, schema, name) — ALTER SCHEMA ... TRANSFER, which sp_rename cannot do |
| Parameters of a procedure or function | db.Parameters(schema, name) → []*Parameter |
| Filtered listings | db.TablesFiltered(f) / ViewsFiltered / StoredProceduresFiltered / UserDefinedFunctionsFiltered (and the System... forms) — see Filtering a listing |
| What may this login do here? | db.Capabilities() → *DatabaseCapabilities |
| Partition functions | db.PartitionFunctions() / db.PartitionFunctionByName(name) |
| Partition schemes | db.PartitionSchemes() / db.PartitionSchemeByName(name) |
| Extended properties | db.ExtendedProperties(level) / db.AddExtendedProperty(...) / db.SetExtendedProperty(...) / db.DropExtendedProperty(...) |
Database.Certificates |
db.Certificates() / db.CertificateByName(name) / db.CreateCertificate(spec) / cert.Drop() — see Certificates |
| Database master key | db.HasMasterKey() / db.CreateMasterKey(password) |
| Column master keys | db.ColumnMasterKeys() / db.ColumnMasterKeyByName(name) / db.CreateColumnMasterKey(...) / ...WithSignature(...) |
| Column encryption keys | db.ColumnEncryptionKeys() / db.ColumnEncryptionKeyByName(name) / db.CreateColumnEncryptionKey(name, values) |
| Security policies (RLS) | db.SecurityPolicies() / db.SecurityPolicyByName(schema, name) |
Database.RecoveryModel |
db.SetRecoveryModel(model) |
Database.CompatibilityLevel |
db.SetCompatibilityLevel(level) |
| Space used | db.SpaceUsed() |
| Every table's row count / space used, in one query | db.TableRowCounts() / db.TableSpaceUsedAll() (keyed by object_id) |
| ALTER DATABASE SET options | db.Options() / db.SetDatabaseOption(opt, value) |
| Restrict access (single/multi/restricted user) | db.SetUserAccess(mode) |
| Take offline / bring online | db.SetOffline() / db.SetOnline() |
| Change ownership | db.SetOwner(principal) |
| Database Scoped Configuration | db.DatabaseScopedConfigs() / db.SetDatabaseScopedConfig(name, value, forSecondary) |
| Query Store | db.QueryStore() / db.SetQueryStoreOptions(opts) / db.FlushQueryStore() / db.ClearQueryStore() |
| Every file, incl. log | db.Files() |
| Add / alter / remove file | db.AddFile(spec) / db.AlterFile(name, m) / db.RemoveFile(name) |
| Add / remove filegroup | db.AddFileGroup(name) / db.RemoveFileGroup(name) |
| Filegroup default / read-only | db.SetDefaultFileGroup(name) / db.SetFileGroupReadOnly(name, ro) |
| CREATE DATABASE file placement | CreateDatabaseOptions.PrimaryFile / .LogFile (*DatabaseFileSpec) |
| Change tracking | db.ChangeTracking() / db.SetChangeTracking(info) |
| Table change tracking | db.TableChangeTracking() / db.TableChangeTrackingFor(schema, name) / db.SetTableChangeTracking(...) |
| Database-level permissions | db.DatabasePermissions() / db.Grant|Deny|RevokeDatabasePermission(...) |
Table
| SMO equivalent | gosmo |
|---|---|
Database.Tables (no-I/O handle) |
db.Table(schema, name) — works under WithScript, where TableByName's catalog read has nothing to find |
Table.Columns |
t.Columns() |
Table.Indexes |
t.Indexes() / t.IndexByName(name) |
| XML indexes | t.XMLIndexes() → []*XMLIndex (primary/secondary, and which primary) |
Table.ForeignKeys |
t.ForeignKeys() / t.ForeignKeyByName(name) |
Table.Checks |
t.CheckConstraints() |
Table.Statistics |
t.Statistics() / t.StatisticByName(name) |
Table.Partitions |
t.Partitions() |
Table.Triggers |
t.Triggers() |
Table.RowCount |
t.RowCount() (all tables at once: db.TableRowCounts()) |
| Rows matching a filter predicate | t.CountWhere(predicate) |
| Validate a filter predicate | t.CheckWhereSyntax(predicate) |
| Object details (lock escalation, ANSI_NULLS, CDC, temporal, ledger, ...) | t.Detail() |
Space used (sp_spaceused-style) |
t.SpaceUsed() (all tables at once: db.TableSpaceUsedAll()) |
| Truncate | t.TruncateTable() |
| Fragmentation | t.FragmentationStats(mode) |
| Rebuild all indexes | t.RebuildAllIndexes(fillFactor) |
| Update all statistics | t.UpdateAllStatistics(samplePct) |
| Create index | t.CreateIndex(req) — every index type, see below |
| Alter column | t.AlterColumn(col) |
| Drop / rename a column | t.DropColumn(name) / t.RenameColumn(name, newName) |
| Drop a constraint | t.DropConstraint(name) |
Where the rows live (ON clause) |
t.DataSpace() → DataSpace (filegroup or partition scheme) |
| Columns of a table or view | db.ObjectColumns(schema, name) — Table.Columns reaches tables only |
Index
| gosmo |
|---|
idx.Rebuild(t, fillFactor) |
idx.RebuildWithOptions(t, fillFactor, padIndex, dataCompression) |
idx.Reorganize(t) |
idx.Disable(t) / idx.Enable(t) |
idx.Rename(t, newName) — also renames a PK/UNIQUE constraint |
idx.SetOptions(t, ignoreDupKey, allowRowLocks, allowPageLocks) |
idx.SetLockOptions(t, allowRowLocks, allowPageLocks) — no IGNORE_DUP_KEY, which a PK/UNIQUE-backing index rejects |
idx.SetIncludedColumns(t, columns) — via CREATE INDEX ... DROP_EXISTING |
idx.UpdateStatistics(t) |
idx.StorageInfo(t) — filegroup, partitioning, allocation-unit space |
idx.Fragmentation(t, mode) — one index (t.FragmentationStats(mode) does all) |
idx.DataSpace — the filegroup or partition scheme it is on, read with the index |
idx.Drop(t) |
Index.Type is a sys.indexes.type_desc value — IndexTypeClustered,
IndexTypeNonClustered, IndexTypeXML, IndexTypeSpatial,
IndexTypeColumnStore, IndexTypeClusteredColumnStore, or the server's own
text for a type gosmo has no constant for (e.g. NONCLUSTERED HASH), so it
is never empty for an index that exists. idx.Type.IsColumnStore() covers
both columnstore forms — neither has an INCLUDE list, so
SetIncludedColumns rejects them rather than silently producing a rowstore
index.
CreateIndexRequest creates any of them, and which of its fields apply
depends on Type:
| Type | Statement | Its own fields |
|---|---|---|
IndexTypeClustered / IndexTypeNonClustered (and the zero value) |
CREATE [UNIQUE] CLUSTERED|NONCLUSTERED INDEX |
IsUnique, IncludedColumns and FilterDefinition (nonclustered only) |
IndexTypeColumnStore |
CREATE NONCLUSTERED COLUMNSTORE INDEX |
FilterDefinition, CompressionDelay |
IndexTypeClusteredColumnStore |
CREATE CLUSTERED COLUMNSTORE INDEX |
takes no key columns at all — it covers every column |
IndexTypeXML |
CREATE [PRIMARY] XML INDEX |
IsPrimaryXML, or PrimaryXMLIndex + SecondaryXMLType |
IndexTypeSpatial |
CREATE SPATIAL INDEX ... USING |
Tessellation, BoundingBox (the GEOMETRY_ schemes), GridLevels, CellsPerObject |
A combination the server would reject is refused before anything is executed — a unique columnstore index, an ordered columnstore column list, a fill factor on a columnstore index, a geography index with a bounding box, a secondary XML index naming no primary — with an error naming the field rather than a parse error naming a column number.
Statistics
| SSMS equivalent | gosmo |
|---|---|
| Statistics of a table | t.Statistics() / t.CreateStatistic(name, cols, pct) |
... with a filter, FULLSCAN, NORECOMPUTE, INCREMENTAL |
t.CreateStatisticWithOptions(req) |
| Statistic's key columns | st.Columns() |
DBCC SHOW_STATISTICS header |
st.Header() → *StatisticHeader |
| ... density vector | st.DensityVector() → []*StatisticDensity |
| ... histogram | st.Histogram() → []*StatisticHistogramStep |
| One statistic by name | t.StatisticByName(name) |
| Update / drop | st.Update(samplePct) / st.Drop() |
| Rename | st.Rename(newName) |
Login
| gosmo |
|---|
srv.CreateLogin(name, password, opts) |
login.ChangePassword(newPassword) |
login.Enable() / login.Disable() |
login.AddServerRoleMember(role) |
login.RemoveServerRoleMember(role) |
login.Drop() |
login.Rename(newName) |
login.SetDefaultDatabase(name) / login.SetDefaultLanguage(name) |
login.SetPasswordPolicy(checkPolicy, checkExpiration) |
login.ChangePasswordWithOptions(pw, mustChange, unlock) |
login.MapCredential(name) / login.UnmapCredential(name) |
login.Details() — locked/expired/policy/last-login status |
login.ResolveMapping() — fills login.MappedObject for a certificate- or asymmetric-key-mapped login |
login.UserMappings() / login.MapToDatabase(...) / login.UnmapFromDatabase(db) |
Capabilities of the connected login
What the login on this connection may actually do — its fixed-role memberships and its permission states — in one round trip per scope, so a caller can gate its UI up front instead of discovering permissions from failed calls.
caps, _ := srv.Capabilities()
if caps.Has("ALTER ANY LOGIN") { /* offer New Login */ }
if !caps.Allows("SHUTDOWN") { /* grey out Shutdown */ }
dcaps, _ := db.Capabilities()
if !dcaps.Accessible { /* don't expand this database at all */ }
if dcaps.Permits("BACKUP DATABASE") { /* offer Back Up */ }
ProbedServerRoles, ProbedServerPermissions, ProbedDatabaseRoles and
ProbedDatabasePermissions are the names that get asked about — a working
subset chosen for what an application actually gates on, not the grantable
catalogs ServerPermissionNames()/DatabasePermissionNames() return.
The answer is three-way, and that is the point. HAS_PERMS_BY_NAME
returns NULL without raising for a permission the instance does not define,
so a permission introduced in a later version reads as CapabilityUnknown on
an older one rather than as denied, and a caller that folds unknown into
denied hides a feature on every instance that names it differently.
| Question | Method |
|---|---|
| Should I offer this? | Has(name) — known to be held |
| Should I withhold this? | Allows(name) (server) / Permits(name) (database) — not known to be denied |
| Exact state | Permission(name) → CapabilityGranted / CapabilityDenied / CapabilityUnknown |
| Role membership | InServerRole(name) / InRole(name), IsSysadmin() |
| Did the probe run at all? | Probed() |
Has and Allows are deliberately not opposites: withholding must fail
open, because the server remains the authority and refusing something a
sysadmin may well be allowed to do is the worse error. sysadmin is not
folded into InServerRole because SQL Server does not fold it in either —
IS_SRVROLEMEMBER('SQLAgentUserRole') is 0 for sa — and a role test cannot
fail open on its own, which is what Probed() is for: InServerRole answers
false for a role never asked about exactly as for one the login is not in.
At database scope, Accessible is HAS_DBACCESS and is the one field to
check before expanding a database or opening its properties, since every
folder under an inaccessible one fails separately and identically. A database
the login cannot open answers unknown to every permission — there was nothing
inside it to ask — so Allows alone would report "not known to be denied"
for exactly the databases the login has no business writing to. Permits is
Allows plus that accessibility, and is the database-scope test for
withholding. Every method is nil-safe; a nil *DatabaseCapabilities is
"nothing known" and fails open, but the zero value is not — its
Accessible is false, which reads as a measured "cannot open this".
Filtering a listing
An ObjectFilter narrows a catalog listing at the server rather than in the
caller — the SSMS Object Explorer "Filter Settings" dialog.
tables, _ := db.TablesFiltered(gosmo.ObjectFilter{
Name: []gosmo.TextCriterion{{Op: gosmo.TextContains, Value: "order"}},
Schema: []gosmo.TextCriterion{{Op: gosmo.TextNotEquals, Value: "staging"}},
Created: []gosmo.DateCriterion{{Op: gosmo.DateAfter, Day: cutoff}},
})
| Family | Method |
|---|---|
| Tables | db.TablesFiltered(f) |
| Views | db.ViewsFiltered(f) / db.SystemViewsFiltered(f) |
| Stored procedures | db.StoredProceduresFiltered(f) / db.SystemStoredProceduresFiltered(f) |
| Functions | db.UserDefinedFunctionsFiltered(f) / db.SystemFunctionsFiltered(f) |
Criteria are AND-ed, never OR-ed, and a zero ObjectFilter narrows nothing —
the unfiltered listing is the same call with an empty one (f.Empty()
reports which). TextOp is TextContains, TextNotContains, TextEquals
or TextNotEquals; DateOp is DateOn, DateBefore or DateAfter, all
over whole calendar days, since a creation date is a timestamp and "created
on the 20th" means the day. MemoryOptimized applies only to the table
listing, whose catalog view is the only one with such a column; elsewhere it
is ignored rather than failing, because a filter describes what the caller
wants and not every family can express all of it.
Matching is case-insensitive regardless of the database's collation — the
comparison lowercases both sides, because a bare LIKE follows the collation
and would drop rows on a case-sensitive instance. The pattern is escaped with
an ESCAPE clause, because %, _ and [ are legal in an identifier and
an unescaped filter for pct_1 also matches pct1100.
Dependencies, search, permissions, and execution plans
| SMO / SSMS equivalent | gosmo |
|---|---|
| Object dependencies (uses) | db.Dependencies(schema, name) |
| Object dependencies (used by) | db.Dependents(schema, name) |
| Object search | db.Search(pattern) |
| Securable search (for a permissions picker) | db.FindSecurables(gosmo.SecurableSearch{Name: ..., Limit: ...}) → []SecurableRef (schemas, tables, views) |
| Object permissions | db.Permissions(schema, name) |
| Grant / deny / revoke | db.GrantPermission(...) / db.DenyPermission(...) / db.RevokePermission(...) |
| Schema permissions | db.SchemaPermissions(schema) |
| Grant / deny / revoke (schema) | db.GrantSchemaPermission(...) / db.DenySchemaPermission(...) / db.RevokeSchemaPermission(...) |
| Every securable one principal holds | db.PermissionsForPrincipal(principal) |
| Permissions with modifiers | db.Grant|Deny|RevokePermissionWithOptions(...) / ...SchemaPermissionWithOptions(...) / ...DatabasePermissionWithOptions(...) |
| Column permissions | db.ColumnPermissions(schema, name) / db.ColumnPermissionsForPrincipal(principal) |
| Grant / deny / revoke (column) | db.Grant|Deny|RevokeColumnPermission(schema, name, perm, cols, principal) |
| Effective permissions | db.EffectivePermissions(principal) / db.EffectiveObjectPermissions(schema, name, principal) / db.EffectiveSchemaPermissions(schema, principal) |
| Permission-name catalogs (for pickers) | gosmo.ObjectPermissionNames() / SchemaPermissionNames() / DatabasePermissionNames() / ServerPermissionNames() / ColumnPermissionNames() |
| Estimated execution plan | db.EstimatedPlan(sql) (SET SHOWPLAN_XML, statement not run) |
| Actual execution plan | db.ActualPlan(sql) (SET STATISTICS XML, statement runs) |
| Every plan a multi-statement batch produced | plan.All (plan.XML is the last of them) |
Every Grant|Deny|Revoke... method has a ...WithOptions counterpart taking
a PermissionOptions, at all four scopes (object, column, schema, database,
server). The zero value renders exactly the statement the plain method
renders — the plain methods are one-line delegations to the WithOptions
form, so there is one renderer and one set of error strings rather than two
that have to be kept in step.
// WITH GRANT OPTION, and the CASCADE that taking such a grant back requires.
db.GrantPermissionWithOptions("dbo", "Orders", gosmo.PermSelect, "app_reader",
gosmo.PermissionOptions{WithGrantOption: true})
db.RevokePermissionWithOptions("dbo", "Orders", gosmo.PermSelect, "app_reader",
gosmo.PermissionOptions{Cascade: true})
// Downgrade WITH GRANT OPTION back to a plain GRANT (REVOKE GRANT OPTION FOR).
db.RevokePermissionWithOptions("dbo", "Orders", gosmo.PermSelect, "app_reader",
gosmo.PermissionOptions{GrantOptionOnly: true})
A modifier the verb has no form for is rejected rather than quietly dropped —
WithGrantOption on a DENY, Cascade on a GRANT. Column permissions are
their own grants, separate from the object-level ones (Permissions reports
those), and only SELECT, UPDATE and REFERENCES have a column-level form
at all; ColumnPermissionNames() is that catalog.
Effective*Permissions answers "what can this principal actually do", with
role membership, inherited scopes, ownership and DENY already resolved —
SSMS's Effective tab. It resolves by impersonating the principal, so the
argument must be a database user (or, for srv.EffectiveServerPermissions,
a login): SQL Server refuses to impersonate a role, and fn_my_permissions
has no principal argument to use instead.
Scripter
sc := gosmo.NewScripter(db, gosmo.DefaultScriptOptions())
ddl, _ := sc.ScriptTable("dbo", "MyTable")
ddl, _ := sc.ScriptView("dbo", "MyView")
ddl, _ := sc.ScriptStoredProcedure("dbo", "MyProc")
ddl, _ := sc.ScriptFunction("dbo", "MyFunc")
ddl, _ := sc.ScriptTrigger("dbo", "MyTrigger")
ddl, _ := sc.ScriptIndex("dbo", "MyTable", "IX_MyTable_a")
ddl, _ := sc.ScriptCheckConstraint("dbo", "MyTable", "CK_MyTable_a")
ddl, _ := sc.ScriptForeignKey("dbo", "MyTable", "FK_MyTable_Other")
ddl, _ := sc.ScriptSequence("dbo", "MySeq")
ddl, _ := sc.ScriptSynonym("dbo", "MySyn")
ddl, _ := sc.ScriptSchema("sales")
ddl, _ := sc.ScriptUser("app_user")
ddl, _ := sc.ScriptDatabaseRole("app_rw")
ddl, _ := sc.ScriptPartitionFunction("pfMonthly")
ddl, _ := sc.ScriptPartitionScheme("psMonthly")
ddl, _ := sc.ScriptSecurityPolicy("sec", "TenantFilter")
ddl, _ := sc.ScriptColumnMasterKey("CMK1")
ddl, _ := sc.ScriptColumnEncryptionKey("CEK1")
ddl, _ := sc.ScriptDatabase()
// Logins and server roles belong to no database, so they have their own
// scripter.
ssc := gosmo.NewServerScripter(srv, gosmo.DefaultScriptOptions())
ddl, _ := ssc.ScriptLogin("app_login")
ddl, _ := ssc.ScriptServerRole("ops")
ScriptOptions.Verb selects the statement form: ScriptCreate (the
default), ScriptDrop, ScriptDropAndCreate — the DROP and the CREATE, in
that order and in separate batches — or ScriptAlter, which applies to
module objects (view, procedure, function, trigger) and rewrites the leading
CREATE of the stored definition, leaving a CREATE OR ALTER definition
alone. The older ScriptDrops bool is still honoured, and means
Verb = ScriptDrop while Verb is left at its zero value.
There are also DML templates, in the shape SSMS's "SELECT To"/"INSERT To"
produce — ScriptSelect, ScriptInsert, ScriptUpdate, ScriptDelete,
ScriptExecute and ScriptFunctionCall. They carry <name, type,>
placeholders wherever the operator has to supply a value and are
deliberately not runnable as they stand; ScriptInsert/ScriptUpdate leave
out identity and computed columns, which reject an explicit value. The
parameter metadata behind ScriptExecute is Database.Parameters(schema, name), which reads sys.parameters for a procedure or function.
ScriptOptions.IncludeHeaders and IncludeIfNotExists apply to
ScriptTable and ScriptDatabase only — the view/procedure/function/trigger
methods return the module's definition verbatim from sys.sql_modules and
synthesize no DDL to guard. The existence check is per statement, never a
block spanning several: GO is a client-side batch break, so a BEGIN
block containing one is split across batches and the script can't parse.
ScriptTable emits a unique constraint as the ALTER TABLE ... ADD CONSTRAINT it really is rather than as a CREATE INDEX, and skips XML and
spatial indexes with a comment naming what was left out, their DDL having no
generic form here.
Iterators (*Seq)
Every collection method has a FooSeq(ctx, ...) counterpart in iter.go
returning an iter.Seq2[T, error], for ranging over a collection without
materializing the slice at the call site:
for t, err := range db.TableSeq(ctx) {
if err != nil { return err }
fmt.Println(t.FullName())
}
The fetch is deferred until the iterator is ranged over — an iterator built
and never ranged queries nothing — but it is not streaming: the
underlying FooContext method runs to completion first, and the loop then
yields from the slice it returned. So ctx cancels the fetch, an error
arrives as a single (zero, err) yield in place of any items rather than
partway through, and breaking out early saves no query work and no memory.
These exist for range-over-func ergonomics, not to bound memory or stop the
server mid-scan; where that matters, use the ...Context method with a
bounded query.
Breaking, since v0.0.7: these took no context.Context before — they
wrapped the non-Context collection method, i.e. context.Background().
db.TableSeq() becomes db.TableSeq(ctx), for all 75 that existed then
(91 now).
Scripting pending writes (WithScript)
Distinct from the Scripter above (which generates CREATE DDL for objects
that already exist): WithScript captures the exact statement(s) a set of
pending write calls would run, without running them — for an editor-style
"preview the SQL" or "script my changes instead of applying them" action.
ctx, script := gosmo.WithScript(context.Background())
srv.GrantServerPermissionContext(ctx, "CONNECT SQL", "app_user")
db.SetDatabaseOptionContext(ctx, gosmo.DBOptAutoShrink, "ON")
for _, stmt := range script.Statements {
fmt.Println(stmt) // never executed against the server
}
Every write method in the package funnels through one of two chokepoints
(Server.execContext, Database.exec); WithScript intercepts there, so
this works for any write call, not just an allowlisted subset. Database-
scoped statements carry their own USE [db]; prefix, since the caller may
run the resulting script against a session scoped to a different database
(or none) than the one that produced it. Read methods are unaffected —
only the two exec chokepoints consult the collector.
Bound parameters are substituted into the captured text as literals, since
a script pasted into a query editor has nothing to bind @p1 to, and
ExecProc is captured as the EXEC form it would run — inputs as literals,
OUTPUT parameters as a DECLAREd variable — rather than as the bare
procedure name the driver sends over RPC.
gosmo.Scripting(ctx) reports whether a context is one of these. It matters
to any caller mirroring a write into its own state: under WithScript the
write returns success without the server ever seeing it, so a rename
followed by a re-read by the new name finds nothing. gosmo honours this
for its own cached state too — a scripted Rename/Enable/SetOwner
leaves the object it was called on unchanged. The lookup-free handles
(srv.Database(name), srv.Login(name), srv.Alert(name), srv.Job(name),
srv.Operator(name), srv.Schedule(name)) exist for the same reason: an
object whose CREATE was only collected can't be found by a ...ByName
query, and the Create* methods return one of these handles under
WithScript.
Backup & Restore
srv.Backup(gosmo.BackupOptions{
Database: "MyDB",
Devices: []string{`C:\Backups\MyDB.bak`},
CopyOnly: true,
// Optional: receive "N percent processed" notices as the backup runs
// (Stats defaults to 10 automatically once Progress is set).
Progress: func(pct int, message string) { fmt.Println(pct, message) },
})
srv.Restore(gosmo.RestoreOptions{
Database: "MyDB_Restored",
Devices: []string{`C:\Backups\MyDB.bak`},
RelocateFiles: []gosmo.RelocateFile{
{LogicalName: "MyDB", PhysicalName: `C:\Data\MyDB.mdf`},
{LogicalName: "MyDB_log", PhysicalName: `C:\Data\MyDB.ldf`},
},
Recovery: true,
Replace: true,
// Optional: which backup set on the device to restore (WITH FILE = n,
// 1-based, as reported by BackupHeader.Position). Left at 0, SQL Server
// restores the first set — so an appended differential or log needs this.
FileNumber: 1,
// Optional: same progress callback as Backup, above.
Progress: func(pct int, message string) { fmt.Println(pct, message) },
})
// File / filegroup backup and restore. There is no BACKUP FILES verb in
// T-SQL — these render as a BACKUP/RESTORE DATABASE carrying FILE = /
// FILEGROUP = clauses — and at least one file or filegroup is required.
srv.Backup(gosmo.BackupOptions{
Database: "MyDB",
Action: gosmo.BackupActionFiles,
FileGroups: []string{"FG_Archive"},
Devices: []string{`C:\Backups\MyDB_FG.bak`},
})
// Inspect a backup device before restoring — SSMS's Restore Database
// dialog's backup-set/file picker.
headers, _ := srv.BackupHeaders(`C:\Backups\MyDB.bak`)
files, _ := srv.BackupFileList(`C:\Backups\MyDB.bak`) // first set on the device
err := srv.VerifyBackup(`C:\Backups\MyDB.bak`)
// A device backups were appended to holds one set per backup, and their file
// lists differ. Pass the same 1-based set number to the file list and to the
// restore, or the MOVE clauses name logical files the restored set doesn't
// contain and SQL Server rejects the statement.
files, _ = srv.BackupFileListForSet(`C:\Backups\MyDB.bak`, headers[1].Position)
SQL Server Agent
Everything under SSMS's SQL Server Agent node that a SQL-only client can reach: jobs and their steps, shared schedules, alerts, operators, and the categories they're filed under. WMI alerts and performance-condition alerts are visible but not manageable — see Features intentionally excluded.
// Is Agent even running? (Reported, not inferred from a failed call.)
status, _ := srv.AgentInfo()
fmt.Println(status.Running, status.StatusText, status.LastStartupTime)
srv.Job(name), srv.Alert(name), srv.Operator(name) and
srv.Schedule(name) return a no-I/O handle carrying only the name — the
Agent counterparts of srv.Database/srv.Login. Every write method on
those types addresses its object by name, so a handle is enough to keep
operating on one you already know exists; the ...ByName form is what
queries msdb and populates the cached fields. Under WithScript the
handle is the only usable form, and is what CreateJob/CreateAlert/
CreateOperator/CreateSchedule return there.
Jobs and steps
job, _ := srv.CreateJob(gosmo.CreateJobRequest{Name: "NightlyBackup", Enabled: true})
job.AddStep(gosmo.JobStepRequest{
Name: "Run backup",
Subsystem: "TSQL",
Command: "EXEC dbo.RunNightlyBackup",
Database: "MyDB",
OnSuccessAction: 1,
OnFailAction: 2,
})
job.SetEmailNotify("DBA on call", gosmo.NotifyOnFailure)
job.Start("")
// Edit or remove a step in place.
steps, _ := job.Steps()
steps[0].Update(gosmo.JobStepRequest{ /* ... */ })
steps[0].Delete()
// Reorder them: insert at a position, move one step, or reorder the lot.
job.InsertStep(gosmo.JobStepRequest{ /* ... */ }, 2)
job.MoveStep(3, 1)
job.ReorderSteps(func(n int) []int { return []int{3, 1, 2} })
// History, per job or across every job at once.
entries, _ := job.History(50)
recent, _ := srv.JobHistory(200)
JobStep.LastRunDate is when the step last ran (zero — test with IsZero() —
for a step that never has), and LastRunElapsed is LastRunDuration decoded:
the raw field is msdb's HHMMSS integer, so 10230 is 1h 02m 30s, not 10230
seconds. Display code should use LastRunElapsed.
msdb has no procedure that renumbers a step in place, so a move is a delete
followed by an insert at the target position — which is why JobStep carries
the step's whole definition (proxy, additional parameters, CmdExec success
code, target server, run-as user, OS priority) and not just the fields a UI
shows: all of it has to survive the round trip. sp_add_jobstep renumbers
every later step and follows their "go to step N" references, but
sp_delete_jobstep clears such a reference instead of following it, so
ReorderSteps rewrites every reference itself afterwards, through
JobStep.SetFlow. ReorderSteps needs a job read with JobByName — the step
listing is by job_id, which a bare srv.Job(name) handle does not carry.
JobStepRequest's two string fields read an empty value differently, because
msdb does: an empty Database means "leave the step's database alone"
(sp_update_jobstep accepts N'' for @database_name and changes nothing),
while an empty OutputFileName is sent and does clear the step's output
file. There is no way to null the step's database through msdb at all.
Shared schedules
A schedule is an object in its own right, shared by any number of jobs —
Job.AddSchedule creates one and attaches it in a single step, while
AttachSchedule/DetachSchedule wire up (or unwire) one that already
exists without creating or deleting it.
sched, _ := srv.CreateSchedule(gosmo.CreateScheduleRequest{
Name: "Weeknights at 2am",
Enabled: true,
FreqType: gosmo.FreqWeekly,
FreqInterval: gosmo.WeekdayMonday | gosmo.WeekdayTuesday | gosmo.WeekdayWednesday |
gosmo.WeekdayThursday | gosmo.WeekdayFriday,
FreqSubdayType: gosmo.SubdayOnce,
ActiveStartTime: 20000, // HHMMSS — 02:00:00
})
job.AttachSchedule(sched.Name)
// "Occurs every week on Monday, Tuesday, Wednesday, Thursday, Friday at
// 02:00:00. Schedule is active from 2026-07-28."
fmt.Println(sched.Description())
jobs, _ := sched.Jobs() // which jobs this schedule drives
Alerts and operators
op, _ := srv.CreateOperator(gosmo.CreateOperatorRequest{
Name: "DBA on call",
Enabled: true,
EmailAddress: "dba@example.com",
})
alert, _ := srv.CreateAlert(gosmo.CreateAlertRequest{
Name: "Severity 17+",
Enabled: true,
Severity: 17,
})
alert.Notify(op.Name, gosmo.NotifyMethodEmail)
alert.SetJobResponse("NightlyBackup") // run a job in response
// The "referenced by" direction, for an operator's properties page.
alerts, _ := op.NotifyingAlerts()
notified, _ := op.NotifyingJobs()
// Only the alerts gosmo can fully manage (no WMI, no perf counters).
manageable, _ := srv.EventAlerts()
Categories
cats, _ := srv.Categories(gosmo.CategoryClassJob)
srv.CreateCategory(gosmo.CategoryClassAlert, "Storage")
srv.DeleteCategory(gosmo.CategoryClassAlert, "Storage")
Always On availability groups
The whole SSMS Always On node — the group, its replicas, the per-database synchronization state, and the listeners clients connect through.
| SSMS equivalent | gosmo |
|---|---|
| Availability Groups node | srv.AvailabilityGroups() / srv.AvailabilityGroup(name) (no-I/O handle) / srv.AvailabilityGroupByName(name) |
| Availability Replicas node | ag.Replicas() → []*AvailabilityReplica |
| Availability Databases node | ag.Databases() → []*AvailabilityDatabase (queue sizes, rates, SecondaryLagSeconds, last sent/received/hardened/redone/commit times) |
| Availability Group Listeners node | ag.Listeners() → []*AvailabilityGroupListener (with their IP configurations) |
| Group properties | ag.SetAutomatedBackupPreference(p) / SetFailureConditionLevel(n) / SetHealthCheckTimeout(ms) / SetDBFailover(on) / SetDTCSupport(perDB) / SetRequiredSynchronizedSecondariesToCommit(n) |
| Replica properties | r.SetAvailabilityMode(m) / SetFailoverMode(m) / SetSeedingMode(m) / SetSessionTimeout(s) / SetBackupPriority(n) / SetPrimaryRoleAllowConnections(m) / SetSecondaryRoleAllowConnections(m) |
| Read-only routing | r.SetReadOnlyRoutingURL(url) / r.SetReadOnlyRoutingList(list) / r.ReadOnlyRoutingList() |
| Add / remove a replica | ag.AddReplica(spec) / ag.RemoveReplica(serverName) / r.Drop() |
| Add / remove a database | ag.AddDatabase(name) / ag.RemoveDatabase(name) |
| Join / unjoin on a secondary | ag.JoinDatabase(name) / ag.UnjoinDatabase(name) |
| Suspend / resume data movement | ag.SuspendDatabase(name) / ag.ResumeDatabase(name) |
| Listeners | ag.AddListener(spec) / ag.AddListenerIP(dns, ip) / ag.SetListenerPort(dns, port) / ag.RemoveListener(dns) |
| New Availability Group wizard | srv.CreateAvailabilityGroup(req) / ag.Join(clusterType) / ag.GrantCreateAnyDatabase() / ag.DenyCreateAnyDatabase() |
| Failover / forced failover | ag.Failover() / ag.ForceFailoverAllowDataLoss() |
| Drop | ag.Drop() |
Read from the primary when the answer has to be complete.
sys.availability_groups and sys.availability_replicas are cluster-wide
metadata and agree on every replica, but the sys.dm_hadr_* DMVs describe
only what this instance can currently see — most visibly, per-database
queue sizes and commit times are populated only for databases the local
instance actually hosts. ag.PrimaryReplicaServerName and
ag.IsLocalPrimary() are there so a caller can tell where it is and follow
the primary; an empty PrimaryReplicaServerName means "unknown from here",
not "no primary exists".
Setting a group up needs two things below it, both also new here: every
instance must have a database mirroring endpoint started with CONNECT
granted to the other instances' service accounts, and — for certificate
authentication — each instance needs the others' public certificates.
Certificates and the database master key
| SSMS equivalent | gosmo |
|---|---|
| Security → Certificates | db.Certificates() / db.CertificateByName(name) |
| New / drop certificate | db.CreateCertificate(gosmo.CertificateSpec{...}) / cert.Drop() |
| Database master key | db.HasMasterKey() / db.CreateMasterKey(password) |
| Export the public certificate | cert.Encoded() → []byte (CERTENCODED) |
| Import it on another instance | CertificateSpec.FromBinary (CREATE CERTIFICATE ... FROM BINARY, SQL Server 2022+) |
Encoded and FromBinary are the pair that moves a certificate between
instances without filesystem access on either host. The documented route
is BACKUP CERTIFICATE to a file, copy the file, CREATE CERTIFICATE FROM FILE — which a client library cannot do. Only the ASN.1-encoded public
certificate crosses the wire, which is what makes this safe over an ordinary
connection, and it is enough for database mirroring endpoints, where each
instance keeps its own key pair and holds only its peers' public
certificates.
CertificateByName reports a certificate that isn't there as (nil, nil),
not an error — its callers branch on absence as the ordinary case. See
Errors for the package's three not-found conventions.
Database mirroring endpoints
| SSMS equivalent | gosmo |
|---|---|
| Server Objects → Endpoints | srv.DatabaseMirroringEndpoint() → *DatabaseMirroringEndpoint |
| New endpoint | srv.CreateDatabaseMirroringEndpoint(gosmo.EndpointSpec{...}) |
| Start / stop / drop | e.Start() / e.Stop() / e.Drop() |
| Grant CONNECT to a peer's login | e.GrantConnect(login) |
The TCP://host:port form |
e.URL() |
An instance can have at most one database mirroring endpoint, whatever
it is called and however many availability groups use it — a server rule,
not a convention. A second availability group over the same pair of
instances reuses the first one's endpoint and port, so code that sets a
group up should read the endpoint before considering creating one. An
endpoint left STOPPED is the usual reason a replica that looks correctly
configured never synchronizes.
Error log
| SSMS equivalent | gosmo |
|---|---|
| Management → SQL Server Logs | srv.EnumErrorLogs(gosmo.ErrorLogSQLServer) → []*ErrorLogFile |
| Agent → Error Logs | srv.EnumErrorLogs(gosmo.ErrorLogAgent) |
| Open a log | srv.ReadLog(logType, n) → []*ErrorLogEntry |
| ... filtered at the server | srv.ReadLogFiltered(logType, n, gosmo.LogSearch{Text1: ..., From: ..., To: ...}) |
| ... the SQL Server log, shorthand | srv.ReadErrorLog(n) |
| Recycle the log | srv.CycleLog(logType) (srv.CycleErrorLog() is the SQL Server-log shorthand) |
ErrorLogType is the log-type argument xp_readerrorlog and
sp_enumerrorlogs themselves take, so it passes straight through — which is
why the Agent log is readable through the same two methods rather than a
second pair of them. Log number 0 is the current log, 1 the most recent
archive, and so on.
LogSearch is xp_readerrorlog's own arguments 3-6, with its semantics:
Text1 and Text2 are case-insensitive substrings AND-ed together, not
two alternatives, and From/To bound the entry timestamp. Filtering at the
server rather than in the caller is what makes the current log usable on a
busy instance, where it runs to tens of thousands of entries. A zero
LogSearch reads the whole file, which is what ReadLog does.
Server filesystem
SMO's Server.EnumDirectories/EnumFiles, and the fixed-drive list behind
SSMS's file-browse dialogs.
| SSMS equivalent | gosmo |
|---|---|
| Browse a server-side folder | srv.EnumFileSystem(path) → []*FileSystemEntry |
| Drive list in a browse dialog | srv.FixedDrives() → []*FixedDrive |
| Does this path exist? | srv.FileSystemExists(path) → (exists, isDirectory bool, err error) |
Every path here is interpreted by the server, not by the process calling
gosmo — routinely two different machines with different path conventions,
which is the whole reason these exist rather than a caller using
os.ReadDir. Each reads sys.dm_os_enumerate_filesystem /
sys.dm_os_enumerate_fixed_drives on SQL Server 2017 and later, and falls
back to xp_dirtree / xp_fixeddrives otherwise. The fallback reports no
Size and no LastModified; an instance whose version gosmo has not
established takes it, since xp_dirtree exists everywhere and the DMV does
not.
Bulk copy
Streams rows into a table over the TDS bulk-copy protocol — the same fast
path bcp and SSMS's "Import Data" use, far faster than row-by-row
INSERTs.
n, err := db.BulkInsert(gosmo.BulkCopy{
Table: "Orders",
Columns: []string{"OrderID", "CustomerID", "OrderDate"},
Options: gosmo.BulkOptions{TableLock: true},
}, gosmo.SliceRows(rows)) // or your own iter.Seq2[[]any, error], e.g. a CSV reader
Execute stored procedures
Runs a stored procedure as an RPC, so OUTPUT parameters and the return
status come back to the caller — unlike a plain db.Exec-style call.
var rowsAffected int
result, err := db.ExecProc("dbo", "usp_UpdateStock",
gosmo.In("ProductID", 42),
gosmo.Out("RowsAffected", &rowsAffected),
)
fmt.Println(result.ReturnStatus, rowsAffected)
Errors
Every error is wrapped gosmo: <what was being attempted>: %w, including
the ones raised partway through reading a result set — so a cancellation
mid-scan names the operation it interrupted rather than arriving as a bare
context deadline exceeded.
AsSQLError unwraps a driver error into a structured SQLError — number,
severity class, state, originating procedure/line, and (for a batch that
raised more than one) the full All list — without callers needing to
import the underlying driver package themselves.
if _, err := db.CreateTable(req); err != nil {
if sqlErr, ok := gosmo.AsSQLError(err); ok {
fmt.Println(sqlErr.Header()) // "Msg 2714, Level 16, State 6, Line 1"
}
}
ErrNotFound
Every by-name lookup that reports absence as an error wraps ErrNotFound,
so "this object does not exist" is testable without matching on message
text:
db, err := srv.DatabaseByName("Sales")
switch {
case errors.Is(err, gosmo.ErrNotFound):
// create it
case err != nil:
return err // permission, connection, timeout — not absence
}
The distinction matters: a caller that reads any error as absence goes on to create an object it never established was missing, and then reports the creation's failure instead of the permission or connection error that actually stopped it.
Three conventions coexist, deliberately:
- Most by-name lookups —
LoginByName,DatabaseByName,TableByName,UserByName,RoleByName,AgentJobByName,AlertByName,OperatorByName,ScheduleByName,ServerRoleByName,ConfigurationByName,AvailabilityGroupByName, and the Scripter's view/procedure/function lookups — return an error wrappingErrNotFound. CertificateByNamereturns(nil, nil), because its callers branch on absence as the ordinary case rather than the exceptional one.AgentStatusreports an unreachable Agent as a populated value (StatusText"Unknown"), not an error.
AvailabilityGroupByName's not-found error additionally still satisfies
errors.Is(err, sql.ErrNoRows), which it promised before ErrNotFound
existed.
A Drop method does not use IF EXISTS: dropping something that isn't
there comes back as the server's own "Cannot drop ... because it does not
exist", uniformly across every object family. A caller that wants the
idempotent form ignores the error — a decision it can make and this package
cannot make for it. The DDL that Scripter generates does keep
IF EXISTS, since that output exists to be re-run.
Authentication
ConnectionOptions.Auth selects the authentication method:
| Constant | When to use |
|---|---|
AuthSQLServer (default) |
SQL Server login + password |
AuthWindows |
Windows / Kerberos (domain-joined host) |
AuthEntraMSI |
Azure Managed Identity (system- or user-assigned) |
AuthEntraServicePrincipal |
Service principal with secret or certificate |
AuthEntraPassword |
Entra ID user + password (non-interactive) |
AuthEntraInteractive |
Browser-based interactive login |
AuthEntraDeviceCode |
Device code flow |
AuthEntraDefault |
Default credential chain (env → MSI → AzCLI) |
AuthEntraAzCLI |
az login credential |
AuthEntraAzurePipelines |
Azure DevOps pipeline OIDC |
AuthWindows uses native SSPI on Windows. On every other platform it
authenticates via Kerberos instead — run kinit first for ambient
single sign-on, or set ConnectionOptions.Kerberos (KerberosOptions)
for a keytab, realm, credential cache, or custom krb5.conf.
ConnectionOptions.ServerSPN overrides the target SPN when the driver's
own derivation from the address doesn't match (e.g. a load balancer or
CNAME in front of the instance).
ConnectionOptions.AccessTokenProvider, when set, is called to obtain a
bearer token for each new pooled connection — use it instead of the
static AccessToken field for tokens that expire during the connection's
lifetime (Entra tokens are good for roughly an hour). It takes precedence
over both AccessToken and Auth.
ConnectionOptions.SessionInitSQL runs on every pooled connection right
after it is reset, before the first query — the equivalent of SSMS's
Query Execution SET options (e.g. "SET ARITHABORT ON; SET ANSI_NULLS ON").
gosmo.ParseServerAddress(server) parses any address form SSMS's own
"Server name" field accepts — host, host:port, host,port,
host\instance, host\instance,port — into (host, instance, port).
Exported so a caller building its own connection-address UI can reuse the
same parsing Connect/ConnectContext rely on internally.
Connection helpers (internal)
A Database-scoped call has to run USE <db> on the same connection as
its statement, so it can't use the pool directly — it pins a *sql.Conn
for the duration. Server-scoped calls have no USE to redo and go
straight to the pool.
| Helper | Purpose |
|---|---|
Database.withConn |
Acquires a *sql.Conn and runs USE <db> (retried), then hands it to a callback (not retried — the callback is the caller's write), releasing the conn on return. |
Database.query |
Returns *dbRows, whose Close() closes the rows and the conn pinned for them. *sql.Rows.Close alone would leak that conn out of the pool permanently. |
Database.queryRow |
Takes a func(*sql.Row) error scan callback and runs acquire + USE + scan as one retried unit. The scan has to be inside it: QueryRowContext never returns an error, so a scan run afterwards would never be retried. |
Database.exec |
Thin wrapper over withConn for non-SELECT statements; also where WithScript intercepts database-scoped writes. |
Server.query |
Server-scoped rows-returning read, retried — no USE, so a plain *sql.Rows is enough. |
Server.queryRow |
Server-scoped single-row read, same scan-callback shape and reason as Database.queryRow. |
Server.queryRowScan |
queryRow convenience for a plain row.Scan(dest...), sparing the caller a closure. |
withRetry |
Retries each of the read helpers above up to 3 times (linear backoff) on a transient/dropped-connection failure — reads only, since retrying is only safe when the operation is idempotent. |
gosmo.IsRetryable(err) exposes the same transient-failure test
withRetry uses, for callers running their own statements outside
gosmo's query helpers.
Running the examples
export MSSQL_SERVER="localhost:1433"
export MSSQL_USER="sa"
export MSSQL_PASSWORD="YourPassword"
export MSSQL_TRUST_CERT="true" # self-signed dev cert
go run ./examples # guided tour of the whole library
Eight more programs go deeper on one subject each:
| Program | Covers |
|---|---|
go run ./examples/backup |
BACKUP/RESTORE, backup headers and history, progress callbacks, relocating files |
go run ./examples/bulkcopy |
BulkInsert from a slice, a generator, and a streaming CSV |
go run ./examples/diagnostic |
AsSQLError, IsRetryable, ExecProc, execution plans, search, dependencies, DMV reads |
go run ./examples/iterators |
The *Seq API and what its deferred-fetch semantics do and don't buy you |
go run ./examples/jobs |
SQL Server Agent jobs, steps, schedules, operators, alerts |
go run ./examples/maintain |
Files, fragmentation, index rebuilds, statistics, Query Store, change tracking |
go run ./examples/scripting |
The Scripter, and WithScript's collect-instead-of-execute mode |
go run ./examples/security |
Logins, users, roles, and permissions from both directions |
Each creates its own throwaway database and drops it afterwards; nothing
already on the instance is modified. Authentication and the full environment
variable list are documented in examples/README.md.
Features intentionally excluded (require WMI / COM / OS APIs)
- Hardware enumeration (disk, NIC, CPU details beyond what
sys.dm_os_sys_infoprovides) - SQL Server service start/stop/restart
- Performance counters via Windows PDH
- SQL Server Browser service interaction
- Windows Event Log reading
- Registry reads for SQL Server configuration outside
sys.configurations - WMI and performance-condition SQL Server Agent alerts — these are listed
by
srv.Alerts()but not creatable or editable, since they depend on a WMI provider or Windows performance counters.Alert.IsEventAlert()andsrv.EventAlerts()identify the manageable subset. - Multi-server Agent administration (master/target servers) — jobs are
created as
LOCAL, enlisted on(local)
All of the above require WMI or Windows-only APIs and are out of scope for a cross-platform Go library.
Contributing
The codebase is currently unstable and going through regular refactoring, so I'm not accepting pull requests at this time — please open an issue instead. I'll start accepting PRs once the project reaches a released, more stable state. In the near future I'm planning to update the project regularly.
Documentation
¶
Overview ¶
Package gosmo provides a Go library that mimics Microsoft SQL Server Management Objects (SMO). It allows you to connect to SQL Server instances and programmatically manage databases, tables, schemas, users, logins, indexes, stored procedures, and more.
Index ¶
- Constants
- Variables
- func BuildBackupStatement(opts BackupOptions) (string, error)
- func BuildRestoreStatement(opts RestoreOptions) (string, error)
- func ColumnPermissionNames() []string
- func ColumnTypeString(col *Column) string
- func DatabasePermissionNames() []string
- func IsRetryable(err error) bool
- func ObjectPermissionNames() []string
- func ParseServerAddress(server string) (host, instance string, port int)
- func QuoteLiteral(s string) string
- func QuoteName(name string) string
- func SchemaPermissionNames() []string
- func Scripting(ctx context.Context) bool
- func ServerPermissionNames() []string
- func SliceRows(rows [][]any) iter.Seq2[[]any, error]
- type ActiveSession
- type AgentStatus
- type Alert
- func (a *Alert) Disable() error
- func (a *Alert) DisableContext(ctx context.Context) error
- func (a *Alert) Drop() error
- func (a *Alert) DropContext(ctx context.Context) error
- func (a *Alert) Enable() error
- func (a *Alert) EnableContext(ctx context.Context) error
- func (a *Alert) IsEventAlert() bool
- func (a *Alert) NotificationSeq(ctx context.Context) iter.Seq2[*AlertNotification, error]
- func (a *Alert) Notifications() ([]*AlertNotification, error)
- func (a *Alert) NotificationsContext(ctx context.Context) ([]*AlertNotification, error)
- func (a *Alert) Notify(operatorName string, method NotificationMethod) error
- func (a *Alert) NotifyContext(ctx context.Context, operatorName string, method NotificationMethod) error
- func (a *Alert) RemoveNotify(operatorName string) error
- func (a *Alert) RemoveNotifyContext(ctx context.Context, operatorName string) error
- func (a *Alert) Rename(newName string) error
- func (a *Alert) RenameContext(ctx context.Context, newName string) error
- func (a *Alert) SetCategory(category string) error
- func (a *Alert) SetCategoryContext(ctx context.Context, category string) error
- func (a *Alert) SetDatabase(dbName string) error
- func (a *Alert) SetDatabaseContext(ctx context.Context, dbName string) error
- func (a *Alert) SetDelay(d time.Duration) error
- func (a *Alert) SetDelayContext(ctx context.Context, d time.Duration) error
- func (a *Alert) SetJobResponse(jobName string) error
- func (a *Alert) SetJobResponseContext(ctx context.Context, jobName string) error
- func (a *Alert) SetNotificationMessage(msg string) error
- func (a *Alert) SetNotificationMessageContext(ctx context.Context, msg string) error
- func (a *Alert) SetTrigger(errorNumber, severity int) error
- func (a *Alert) SetTriggerContext(ctx context.Context, errorNumber, severity int) error
- type AlertNotification
- type AlertNotificationRef
- type AuthMethod
- type AvailabilityDatabase
- type AvailabilityGroup
- func (ag *AvailabilityGroup) AddDatabase(name string) error
- func (ag *AvailabilityGroup) AddDatabaseContext(ctx context.Context, name string) error
- func (ag *AvailabilityGroup) AddListener(spec AvailabilityListenerSpec) error
- func (ag *AvailabilityGroup) AddListenerContext(ctx context.Context, spec AvailabilityListenerSpec) error
- func (ag *AvailabilityGroup) AddListenerIP(dnsName string, ip AvailabilityListenerIPSpec) error
- func (ag *AvailabilityGroup) AddListenerIPContext(ctx context.Context, dnsName string, ip AvailabilityListenerIPSpec) error
- func (ag *AvailabilityGroup) AddReplica(spec AvailabilityReplicaSpec) error
- func (ag *AvailabilityGroup) AddReplicaContext(ctx context.Context, spec AvailabilityReplicaSpec) error
- func (ag *AvailabilityGroup) DatabaseSeq(ctx context.Context) iter.Seq2[*AvailabilityDatabase, error]
- func (ag *AvailabilityGroup) Databases() ([]*AvailabilityDatabase, error)
- func (ag *AvailabilityGroup) DatabasesContext(ctx context.Context) ([]*AvailabilityDatabase, error)
- func (ag *AvailabilityGroup) DenyCreateAnyDatabase() error
- func (ag *AvailabilityGroup) DenyCreateAnyDatabaseContext(ctx context.Context) error
- func (ag *AvailabilityGroup) Drop() error
- func (ag *AvailabilityGroup) DropContext(ctx context.Context) error
- func (ag *AvailabilityGroup) Failover() error
- func (ag *AvailabilityGroup) FailoverContext(ctx context.Context) error
- func (ag *AvailabilityGroup) ForceFailoverAllowDataLoss() error
- func (ag *AvailabilityGroup) ForceFailoverAllowDataLossContext(ctx context.Context) error
- func (ag *AvailabilityGroup) GrantCreateAnyDatabase() error
- func (ag *AvailabilityGroup) GrantCreateAnyDatabaseContext(ctx context.Context) error
- func (ag *AvailabilityGroup) IsLocalPrimary() bool
- func (ag *AvailabilityGroup) Join(clusterType string) error
- func (ag *AvailabilityGroup) JoinContext(ctx context.Context, clusterType string) error
- func (ag *AvailabilityGroup) JoinDatabase(name string) error
- func (ag *AvailabilityGroup) JoinDatabaseContext(ctx context.Context, name string) error
- func (ag *AvailabilityGroup) ListenerSeq(ctx context.Context) iter.Seq2[*AvailabilityGroupListener, error]
- func (ag *AvailabilityGroup) Listeners() ([]*AvailabilityGroupListener, error)
- func (ag *AvailabilityGroup) ListenersContext(ctx context.Context) ([]*AvailabilityGroupListener, error)
- func (ag *AvailabilityGroup) RemoveDatabase(name string) error
- func (ag *AvailabilityGroup) RemoveDatabaseContext(ctx context.Context, name string) error
- func (ag *AvailabilityGroup) RemoveListener(dnsName string) error
- func (ag *AvailabilityGroup) RemoveListenerContext(ctx context.Context, dnsName string) error
- func (ag *AvailabilityGroup) RemoveReplica(serverName string) error
- func (ag *AvailabilityGroup) RemoveReplicaContext(ctx context.Context, serverName string) error
- func (ag *AvailabilityGroup) ReplicaSeq(ctx context.Context) iter.Seq2[*AvailabilityReplica, error]
- func (ag *AvailabilityGroup) Replicas() ([]*AvailabilityReplica, error)
- func (ag *AvailabilityGroup) ReplicasContext(ctx context.Context) ([]*AvailabilityReplica, error)
- func (ag *AvailabilityGroup) ResumeDatabase(name string) error
- func (ag *AvailabilityGroup) ResumeDatabaseContext(ctx context.Context, name string) error
- func (ag *AvailabilityGroup) Server() *Server
- func (ag *AvailabilityGroup) SetAutomatedBackupPreference(pref string) error
- func (ag *AvailabilityGroup) SetAutomatedBackupPreferenceContext(ctx context.Context, pref string) error
- func (ag *AvailabilityGroup) SetDBFailover(on bool) error
- func (ag *AvailabilityGroup) SetDBFailoverContext(ctx context.Context, on bool) error
- func (ag *AvailabilityGroup) SetDTCSupport(perDB bool) error
- func (ag *AvailabilityGroup) SetDTCSupportContext(ctx context.Context, perDB bool) error
- func (ag *AvailabilityGroup) SetFailureConditionLevel(level int) error
- func (ag *AvailabilityGroup) SetFailureConditionLevelContext(ctx context.Context, level int) error
- func (ag *AvailabilityGroup) SetHealthCheckTimeout(ms int) error
- func (ag *AvailabilityGroup) SetHealthCheckTimeoutContext(ctx context.Context, ms int) error
- func (ag *AvailabilityGroup) SetListenerPort(dnsName string, port int) error
- func (ag *AvailabilityGroup) SetListenerPortContext(ctx context.Context, dnsName string, port int) error
- func (ag *AvailabilityGroup) SetRequiredSynchronizedSecondariesToCommit(n int) error
- func (ag *AvailabilityGroup) SetRequiredSynchronizedSecondariesToCommitContext(ctx context.Context, n int) error
- func (ag *AvailabilityGroup) SuspendDatabase(name string) error
- func (ag *AvailabilityGroup) SuspendDatabaseContext(ctx context.Context, name string) error
- func (ag *AvailabilityGroup) UnjoinDatabase(name string) error
- func (ag *AvailabilityGroup) UnjoinDatabaseContext(ctx context.Context, name string) error
- type AvailabilityGroupListener
- type AvailabilityListenerIP
- type AvailabilityListenerIPSpec
- type AvailabilityListenerSpec
- type AvailabilityReplica
- func (r *AvailabilityReplica) Drop() error
- func (r *AvailabilityReplica) DropContext(ctx context.Context) error
- func (r *AvailabilityReplica) ReadOnlyRoutingList() ([][]string, error)
- func (r *AvailabilityReplica) ReadOnlyRoutingListContext(ctx context.Context) ([][]string, error)
- func (r *AvailabilityReplica) SetAvailabilityMode(mode string) error
- func (r *AvailabilityReplica) SetAvailabilityModeContext(ctx context.Context, mode string) error
- func (r *AvailabilityReplica) SetBackupPriority(priority int) error
- func (r *AvailabilityReplica) SetBackupPriorityContext(ctx context.Context, priority int) error
- func (r *AvailabilityReplica) SetFailoverMode(mode string) error
- func (r *AvailabilityReplica) SetFailoverModeContext(ctx context.Context, mode string) error
- func (r *AvailabilityReplica) SetPrimaryRoleAllowConnections(mode string) error
- func (r *AvailabilityReplica) SetPrimaryRoleAllowConnectionsContext(ctx context.Context, mode string) error
- func (r *AvailabilityReplica) SetReadOnlyRoutingList(list [][]string) error
- func (r *AvailabilityReplica) SetReadOnlyRoutingListContext(ctx context.Context, list [][]string) error
- func (r *AvailabilityReplica) SetReadOnlyRoutingURL(url string) error
- func (r *AvailabilityReplica) SetReadOnlyRoutingURLContext(ctx context.Context, url string) error
- func (r *AvailabilityReplica) SetSecondaryRoleAllowConnections(mode string) error
- func (r *AvailabilityReplica) SetSecondaryRoleAllowConnectionsContext(ctx context.Context, mode string) error
- func (r *AvailabilityReplica) SetSeedingMode(mode string) error
- func (r *AvailabilityReplica) SetSeedingModeContext(ctx context.Context, mode string) error
- func (r *AvailabilityReplica) SetSessionTimeout(seconds int) error
- func (r *AvailabilityReplica) SetSessionTimeoutContext(ctx context.Context, seconds int) error
- type AvailabilityReplicaSpec
- type BackupAction
- type BackupFile
- type BackupHeader
- type BackupInfo
- type BackupOptions
- type BulkCopy
- type BulkOptions
- type Capabilities
- type CapabilityState
- type Catalog
- type CatalogColumn
- type CatalogObject
- type CatalogObjectType
- type Category
- type CategoryClass
- type Certificate
- type CertificateSpec
- type ChangeTrackingInfo
- type CheckConstraint
- type Column
- type ColumnDefault
- type ColumnDefinition
- type ColumnEncryptionKey
- type ColumnEncryptionKeyValue
- type ColumnMasterKey
- type ColumnPermissionEntry
- type CompatibilityLevel
- type ConfigurationOption
- type ConnectionOptions
- type CreateAlertRequest
- type CreateAvailabilityGroupRequest
- type CreateDatabaseOptions
- type CreateIndexRequest
- type CreateJobRequest
- type CreateLoginOptions
- type CreateOperatorRequest
- type CreatePartitionFunctionRequest
- type CreateScheduleRequest
- type CreateSequenceRequest
- type CreateStatisticRequest
- type CreateTableRequest
- type Credential
- type DataSpace
- type DataType
- type Database
- func (d *Database) ActualPlan(sql string) (*ExecutionPlan, error)
- func (d *Database) ActualPlanContext(ctx context.Context, sqlText string) (*ExecutionPlan, error)
- func (d *Database) AddExtendedProperty(name, value string, level ExtendedPropertyLevel) error
- func (d *Database) AddExtendedPropertyContext(ctx context.Context, name, value string, level ExtendedPropertyLevel) error
- func (d *Database) AddFile(spec DatabaseFileSpec) error
- func (d *Database) AddFileContext(ctx context.Context, spec DatabaseFileSpec) error
- func (d *Database) AddFileGroup(name string) error
- func (d *Database) AddFileGroupContext(ctx context.Context, name string) error
- func (d *Database) AddRoleMember(roleName, memberName string) error
- func (d *Database) AddRoleMemberContext(ctx context.Context, roleName, memberName string) error
- func (d *Database) AlterFile(name string, m FileModify) error
- func (d *Database) AlterFileContext(ctx context.Context, name string, m FileModify) error
- func (d *Database) BulkInsert(bc BulkCopy, rows iter.Seq2[[]any, error]) (int64, error)
- func (d *Database) BulkInsertContext(ctx context.Context, bc BulkCopy, rows iter.Seq2[[]any, error]) (int64, error)
- func (d *Database) Capabilities() (*DatabaseCapabilities, error)
- func (d *Database) CapabilitiesContext(ctx context.Context) (*DatabaseCapabilities, error)
- func (d *Database) Catalog() (*Catalog, error)
- func (d *Database) CatalogContext(ctx context.Context) (*Catalog, error)
- func (d *Database) CertificateByName(name string) (*Certificate, error)
- func (d *Database) CertificateByNameContext(ctx context.Context, name string) (*Certificate, error)
- func (d *Database) CertificateSeq(ctx context.Context) iter.Seq2[*Certificate, error]
- func (d *Database) Certificates() ([]*Certificate, error)
- func (d *Database) CertificatesContext(ctx context.Context) ([]*Certificate, error)
- func (d *Database) ChangeTracking() (*ChangeTrackingInfo, error)
- func (d *Database) ChangeTrackingContext(ctx context.Context) (*ChangeTrackingInfo, error)
- func (d *Database) ClearQueryStore() error
- func (d *Database) ClearQueryStoreContext(ctx context.Context) error
- func (d *Database) Collation() string
- func (d *Database) ColumnEncryptionKeyByName(name string) (*ColumnEncryptionKey, error)
- func (d *Database) ColumnEncryptionKeyByNameContext(ctx context.Context, name string) (*ColumnEncryptionKey, error)
- func (d *Database) ColumnEncryptionKeySeq(ctx context.Context) iter.Seq2[*ColumnEncryptionKey, error]
- func (d *Database) ColumnEncryptionKeys() ([]*ColumnEncryptionKey, error)
- func (d *Database) ColumnEncryptionKeysContext(ctx context.Context) ([]*ColumnEncryptionKey, error)
- func (d *Database) ColumnMasterKeyByName(name string) (*ColumnMasterKey, error)
- func (d *Database) ColumnMasterKeyByNameContext(ctx context.Context, name string) (*ColumnMasterKey, error)
- func (d *Database) ColumnMasterKeySeq(ctx context.Context) iter.Seq2[*ColumnMasterKey, error]
- func (d *Database) ColumnMasterKeys() ([]*ColumnMasterKey, error)
- func (d *Database) ColumnMasterKeysContext(ctx context.Context) ([]*ColumnMasterKey, error)
- func (d *Database) ColumnPermissionSeq(ctx context.Context, schema, name string) iter.Seq2[*ColumnPermissionEntry, error]
- func (d *Database) ColumnPermissions(schema, name string) ([]*ColumnPermissionEntry, error)
- func (d *Database) ColumnPermissionsContext(ctx context.Context, schema, name string) ([]*ColumnPermissionEntry, error)
- func (d *Database) ColumnPermissionsForPrincipal(principal string) ([]*ColumnPermissionEntry, error)
- func (d *Database) ColumnPermissionsForPrincipalContext(ctx context.Context, principal string) ([]*ColumnPermissionEntry, error)
- func (d *Database) ColumnPermissionsForPrincipalSeq(ctx context.Context, principal string) iter.Seq2[*ColumnPermissionEntry, error]
- func (d *Database) CompatibilityLevel() CompatibilityLevel
- func (d *Database) CreateCertificate(spec CertificateSpec) error
- func (d *Database) CreateCertificateContext(ctx context.Context, spec CertificateSpec) error
- func (d *Database) CreateColumnEncryptionKey(name string, values []ColumnEncryptionKeyValue) error
- func (d *Database) CreateColumnEncryptionKeyContext(ctx context.Context, name string, values []ColumnEncryptionKeyValue) error
- func (d *Database) CreateColumnMasterKey(name, keyStoreProvider, keyPath string, enclaveComputations bool) error
- func (d *Database) CreateColumnMasterKeyContext(ctx context.Context, name, keyStoreProvider, keyPath string, ...) error
- func (d *Database) CreateColumnMasterKeyWithSignature(name, keyStoreProvider, keyPath string, signature []byte) error
- func (d *Database) CreateColumnMasterKeyWithSignatureContext(ctx context.Context, name, keyStoreProvider, keyPath string, signature []byte) error
- func (d *Database) CreateDate() time.Time
- func (d *Database) CreateMasterKey(password string) error
- func (d *Database) CreateMasterKeyContext(ctx context.Context, password string) error
- func (d *Database) CreatePartitionFunction(req CreatePartitionFunctionRequest) error
- func (d *Database) CreatePartitionFunctionContext(ctx context.Context, req CreatePartitionFunctionRequest) error
- func (d *Database) CreatePartitionScheme(name, functionName string, fileGroups []string) error
- func (d *Database) CreatePartitionSchemeContext(ctx context.Context, name, functionName string, fileGroups []string) error
- func (d *Database) CreateSchema(name, owner string) error
- func (d *Database) CreateSchemaContext(ctx context.Context, name, owner string) error
- func (d *Database) CreateSequence(req CreateSequenceRequest) error
- func (d *Database) CreateSequenceContext(ctx context.Context, req CreateSequenceRequest) error
- func (d *Database) CreateStoredProcedure(schema, name, body string) error
- func (d *Database) CreateStoredProcedureContext(ctx context.Context, schema, name, body string) error
- func (d *Database) CreateSynonym(schema, name, baseObject string) error
- func (d *Database) CreateSynonymContext(ctx context.Context, schema, name, baseObject string) error
- func (d *Database) CreateTable(req CreateTableRequest) error
- func (d *Database) CreateTableContext(ctx context.Context, req CreateTableRequest) error
- func (d *Database) CreateUser(userName, loginName, defaultSchema string) error
- func (d *Database) CreateUserContext(ctx context.Context, userName, loginName, defaultSchema string) error
- func (d *Database) DatabaseExtendedProperties() ([]*ExtendedProperty, error)
- func (d *Database) DatabaseExtendedPropertiesContext(ctx context.Context) ([]*ExtendedProperty, error)
- func (d *Database) DatabaseExtendedPropertySeq(ctx context.Context) iter.Seq2[*ExtendedProperty, error]
- func (d *Database) DatabasePermissionSeq(ctx context.Context) iter.Seq2[*DatabasePermissionEntry, error]
- func (d *Database) DatabasePermissions() ([]*DatabasePermissionEntry, error)
- func (d *Database) DatabasePermissionsContext(ctx context.Context) ([]*DatabasePermissionEntry, error)
- func (d *Database) DatabaseRoleSeq(ctx context.Context) iter.Seq2[*DatabaseRole, error]
- func (d *Database) DatabaseRoles() ([]*DatabaseRole, error)
- func (d *Database) DatabaseRolesContext(ctx context.Context) ([]*DatabaseRole, error)
- func (d *Database) DatabaseScopedConfigSeq(ctx context.Context) iter.Seq2[*DatabaseScopedConfig, error]
- func (d *Database) DatabaseScopedConfigs() ([]*DatabaseScopedConfig, error)
- func (d *Database) DatabaseScopedConfigsContext(ctx context.Context) ([]*DatabaseScopedConfig, error)
- func (d *Database) DenyColumnPermission(schema, name string, permission ObjectPermission, columns []string, ...) error
- func (d *Database) DenyColumnPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) DenyColumnPermissionWithOptions(schema, name string, permission ObjectPermission, columns []string, ...) error
- func (d *Database) DenyColumnPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) DenyDatabasePermission(permission, principal string) error
- func (d *Database) DenyDatabasePermissionContext(ctx context.Context, permission, principal string) error
- func (d *Database) DenyDatabasePermissionWithOptions(permission, principal string, opts PermissionOptions) error
- func (d *Database) DenyDatabasePermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
- func (d *Database) DenyPermission(schema, name string, permission ObjectPermission, principal string) error
- func (d *Database) DenyPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) DenyPermissionWithOptions(schema, name string, permission ObjectPermission, principal string, ...) error
- func (d *Database) DenyPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) DenySchemaPermission(schemaName string, permission ObjectPermission, principal string) error
- func (d *Database) DenySchemaPermissionContext(ctx context.Context, schemaName string, permission ObjectPermission, ...) error
- func (d *Database) DenySchemaPermissionWithOptions(schemaName string, permission ObjectPermission, principal string, ...) error
- func (d *Database) DenySchemaPermissionWithOptionsContext(ctx context.Context, schemaName string, permission ObjectPermission, ...) error
- func (d *Database) Dependencies(schema, name string) ([]*Dependency, error)
- func (d *Database) DependenciesContext(ctx context.Context, schema, name string) ([]*Dependency, error)
- func (d *Database) DependencySeq(ctx context.Context, schema, name string) iter.Seq2[*Dependency, error]
- func (d *Database) DependentSeq(ctx context.Context, schema, name string) iter.Seq2[*Dependency, error]
- func (d *Database) Dependents(schema, name string) ([]*Dependency, error)
- func (d *Database) DependentsContext(ctx context.Context, schema, name string) ([]*Dependency, error)
- func (d *Database) DropDatabaseRole(name string) error
- func (d *Database) DropDatabaseRoleContext(ctx context.Context, name string) error
- func (d *Database) DropExtendedProperty(name string, level ExtendedPropertyLevel) error
- func (d *Database) DropExtendedPropertyContext(ctx context.Context, name string, level ExtendedPropertyLevel) error
- func (d *Database) DropFunction(schema, name string) error
- func (d *Database) DropFunctionContext(ctx context.Context, schema, name string) error
- func (d *Database) DropSchema(name string) error
- func (d *Database) DropSchemaContext(ctx context.Context, name string) error
- func (d *Database) DropSequence(schema, name string) error
- func (d *Database) DropSequenceContext(ctx context.Context, schema, name string) error
- func (d *Database) DropStoredProcedure(schema, name string) error
- func (d *Database) DropStoredProcedureContext(ctx context.Context, schema, name string) error
- func (d *Database) DropSynonym(schema, name string) error
- func (d *Database) DropSynonymContext(ctx context.Context, schema, name string) error
- func (d *Database) DropTable(schema, name string, cascade bool) error
- func (d *Database) DropTableContext(ctx context.Context, schema, name string, cascade bool) error
- func (d *Database) DropTrigger(schema, name string) error
- func (d *Database) DropTriggerContext(ctx context.Context, schema, name string) error
- func (d *Database) DropUser(name string) error
- func (d *Database) DropUserContext(ctx context.Context, name string) error
- func (d *Database) DropView(schema, name string) error
- func (d *Database) DropViewContext(ctx context.Context, schema, name string) error
- func (d *Database) EffectiveObjectPermissionSeq(ctx context.Context, schema, name, principal string) iter.Seq2[*EffectivePermission, error]
- func (d *Database) EffectiveObjectPermissions(schema, name, principal string) ([]*EffectivePermission, error)
- func (d *Database) EffectiveObjectPermissionsContext(ctx context.Context, schema, name, principal string) ([]*EffectivePermission, error)
- func (d *Database) EffectivePermissionSeq(ctx context.Context, principal string) iter.Seq2[*EffectivePermission, error]
- func (d *Database) EffectivePermissions(principal string) ([]*EffectivePermission, error)
- func (d *Database) EffectivePermissionsContext(ctx context.Context, principal string) ([]*EffectivePermission, error)
- func (d *Database) EffectiveSchemaPermissionSeq(ctx context.Context, schemaName, principal string) iter.Seq2[*EffectivePermission, error]
- func (d *Database) EffectiveSchemaPermissions(schemaName, principal string) ([]*EffectivePermission, error)
- func (d *Database) EffectiveSchemaPermissionsContext(ctx context.Context, schemaName, principal string) ([]*EffectivePermission, error)
- func (d *Database) EstimatedPlan(sql string) (*ExecutionPlan, error)
- func (d *Database) EstimatedPlanContext(ctx context.Context, sqlText string) (*ExecutionPlan, error)
- func (d *Database) ExecProc(schema, name string, params ...ProcParam) (ProcResult, error)
- func (d *Database) ExecProcContext(ctx context.Context, schema, name string, params ...ProcParam) (ProcResult, error)
- func (d *Database) ExtendedProperties(level ExtendedPropertyLevel) ([]*ExtendedProperty, error)
- func (d *Database) ExtendedPropertiesContext(ctx context.Context, level ExtendedPropertyLevel) ([]*ExtendedProperty, error)
- func (d *Database) ExtendedPropertySeq(ctx context.Context, level ExtendedPropertyLevel) iter.Seq2[*ExtendedProperty, error]
- func (d *Database) FileGroupSeq(ctx context.Context) iter.Seq2[*FileGroup, error]
- func (d *Database) FileGroups() ([]*FileGroup, error)
- func (d *Database) FileGroupsContext(ctx context.Context) ([]*FileGroup, error)
- func (d *Database) FileSeq(ctx context.Context) iter.Seq2[*DatabaseFileInfo, error]
- func (d *Database) Files() ([]*DatabaseFileInfo, error)
- func (d *Database) FilesContext(ctx context.Context) ([]*DatabaseFileInfo, error)
- func (d *Database) FindSecurables(search SecurableSearch) ([]SecurableRef, error)
- func (d *Database) FindSecurablesContext(ctx context.Context, search SecurableSearch) ([]SecurableRef, error)
- func (d *Database) FlushQueryStore() error
- func (d *Database) FlushQueryStoreContext(ctx context.Context) error
- func (d *Database) GrantColumnPermission(schema, name string, permission ObjectPermission, columns []string, ...) error
- func (d *Database) GrantColumnPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) GrantColumnPermissionWithOptions(schema, name string, permission ObjectPermission, columns []string, ...) error
- func (d *Database) GrantColumnPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) GrantDatabasePermission(permission, principal string) error
- func (d *Database) GrantDatabasePermissionContext(ctx context.Context, permission, principal string) error
- func (d *Database) GrantDatabasePermissionWithOptions(permission, principal string, opts PermissionOptions) error
- func (d *Database) GrantDatabasePermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
- func (d *Database) GrantPermission(schema, name string, permission ObjectPermission, principal string) error
- func (d *Database) GrantPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) GrantPermissionWithOptions(schema, name string, permission ObjectPermission, principal string, ...) error
- func (d *Database) GrantPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) GrantSchemaPermission(schemaName string, permission ObjectPermission, principal string) error
- func (d *Database) GrantSchemaPermissionContext(ctx context.Context, schemaName string, permission ObjectPermission, ...) error
- func (d *Database) GrantSchemaPermissionWithOptions(schemaName string, permission ObjectPermission, principal string, ...) error
- func (d *Database) GrantSchemaPermissionWithOptionsContext(ctx context.Context, schemaName string, permission ObjectPermission, ...) error
- func (d *Database) HasMasterKey() (bool, error)
- func (d *Database) HasMasterKeyContext(ctx context.Context) (bool, error)
- func (d *Database) ID() int
- func (d *Database) IsReadOnly() bool
- func (d *Database) IsSystem() bool
- func (d *Database) Name() string
- func (d *Database) ObjectColumnSeq(ctx context.Context, schema, name string) iter.Seq2[*Column, error]
- func (d *Database) ObjectColumns(schema, name string) ([]*Column, error)
- func (d *Database) ObjectColumnsContext(ctx context.Context, schema, name string) ([]*Column, error)
- func (d *Database) Options() (*DatabaseOptions, error)
- func (d *Database) OptionsContext(ctx context.Context) (*DatabaseOptions, error)
- func (d *Database) ParameterSeq(ctx context.Context, schema, name string) iter.Seq2[*Parameter, error]
- func (d *Database) Parameters(schema, name string) ([]*Parameter, error)
- func (d *Database) ParametersContext(ctx context.Context, schema, name string) ([]*Parameter, error)
- func (d *Database) PartitionFunctionByName(name string) (*PartitionFunction, error)
- func (d *Database) PartitionFunctionByNameContext(ctx context.Context, name string) (*PartitionFunction, error)
- func (d *Database) PartitionFunctionSeq(ctx context.Context) iter.Seq2[*PartitionFunction, error]
- func (d *Database) PartitionFunctions() ([]*PartitionFunction, error)
- func (d *Database) PartitionFunctionsContext(ctx context.Context) ([]*PartitionFunction, error)
- func (d *Database) PartitionSchemeByName(name string) (*PartitionScheme, error)
- func (d *Database) PartitionSchemeByNameContext(ctx context.Context, name string) (*PartitionScheme, error)
- func (d *Database) PartitionSchemeSeq(ctx context.Context) iter.Seq2[*PartitionScheme, error]
- func (d *Database) PartitionSchemes() ([]*PartitionScheme, error)
- func (d *Database) PartitionSchemesContext(ctx context.Context) ([]*PartitionScheme, error)
- func (d *Database) PermissionSeq(ctx context.Context, schema, name string) iter.Seq2[*PermissionEntry, error]
- func (d *Database) Permissions(schema, name string) ([]*PermissionEntry, error)
- func (d *Database) PermissionsContext(ctx context.Context, schema, name string) ([]*PermissionEntry, error)
- func (d *Database) PermissionsForPrincipal(principal string) ([]*PrincipalSecurable, error)
- func (d *Database) PermissionsForPrincipalContext(ctx context.Context, principal string) ([]*PrincipalSecurable, error)
- func (d *Database) PermissionsForPrincipalSeq(ctx context.Context, principal string) iter.Seq2[*PrincipalSecurable, error]
- func (d *Database) QueryStore() (*QueryStoreInfo, error)
- func (d *Database) QueryStoreContext(ctx context.Context) (*QueryStoreInfo, error)
- func (d *Database) RecoveryModel() RecoveryModel
- func (d *Database) RecoveryStatus() (*DatabaseRecoveryStatus, error)
- func (d *Database) RecoveryStatusContext(ctx context.Context) (*DatabaseRecoveryStatus, error)
- func (d *Database) RemoveFile(name string) error
- func (d *Database) RemoveFileContext(ctx context.Context, name string) error
- func (d *Database) RemoveFileGroup(name string) error
- func (d *Database) RemoveFileGroupContext(ctx context.Context, name string) error
- func (d *Database) RemoveRoleMember(roleName, memberName string) error
- func (d *Database) RemoveRoleMemberContext(ctx context.Context, roleName, memberName string) error
- func (d *Database) RenameObject(schema, oldName, newName string) error
- func (d *Database) RenameObjectContext(ctx context.Context, schema, oldName, newName string) error
- func (d *Database) RenameTable(schema, oldName, newName string) error
- func (d *Database) RenameTableContext(ctx context.Context, schema, oldName, newName string) error
- func (d *Database) RevokeColumnPermission(schema, name string, permission ObjectPermission, columns []string, ...) error
- func (d *Database) RevokeColumnPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) RevokeColumnPermissionWithOptions(schema, name string, permission ObjectPermission, columns []string, ...) error
- func (d *Database) RevokeColumnPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) RevokeDatabasePermission(permission, principal string) error
- func (d *Database) RevokeDatabasePermissionContext(ctx context.Context, permission, principal string) error
- func (d *Database) RevokeDatabasePermissionWithOptions(permission, principal string, opts PermissionOptions) error
- func (d *Database) RevokeDatabasePermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
- func (d *Database) RevokePermission(schema, name string, permission ObjectPermission, principal string) error
- func (d *Database) RevokePermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) RevokePermissionWithOptions(schema, name string, permission ObjectPermission, principal string, ...) error
- func (d *Database) RevokePermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, ...) error
- func (d *Database) RevokeSchemaPermission(schemaName string, permission ObjectPermission, principal string) error
- func (d *Database) RevokeSchemaPermissionContext(ctx context.Context, schemaName string, permission ObjectPermission, ...) error
- func (d *Database) RevokeSchemaPermissionWithOptions(schemaName string, permission ObjectPermission, principal string, ...) error
- func (d *Database) RevokeSchemaPermissionWithOptionsContext(ctx context.Context, schemaName string, permission ObjectPermission, ...) error
- func (d *Database) RoleByName(name string) (*DatabaseRole, error)
- func (d *Database) RoleByNameContext(ctx context.Context, name string) (*DatabaseRole, error)
- func (d *Database) RoleMemberSeq(ctx context.Context, roleName string) iter.Seq2[*RoleMember, error]
- func (d *Database) RoleMembers(roleName string) ([]*RoleMember, error)
- func (d *Database) RoleMembersContext(ctx context.Context, roleName string) ([]*RoleMember, error)
- func (d *Database) SchemaByName(name string) (*Schema, error)
- func (d *Database) SchemaByNameContext(ctx context.Context, name string) (*Schema, error)
- func (d *Database) SchemaPermissionSeq(ctx context.Context, schemaName string) iter.Seq2[*PermissionEntry, error]
- func (d *Database) SchemaPermissions(schemaName string) ([]*PermissionEntry, error)
- func (d *Database) SchemaPermissionsContext(ctx context.Context, schemaName string) ([]*PermissionEntry, error)
- func (d *Database) SchemaSeq(ctx context.Context) iter.Seq2[*Schema, error]
- func (d *Database) Schemas() ([]*Schema, error)
- func (d *Database) SchemasContext(ctx context.Context) ([]*Schema, error)
- func (d *Database) Search(pattern string) ([]*SearchResult, error)
- func (d *Database) SearchContext(ctx context.Context, pattern string) ([]*SearchResult, error)
- func (d *Database) SearchSeq(ctx context.Context, pattern string) iter.Seq2[*SearchResult, error]
- func (d *Database) SecurityPolicies() ([]*SecurityPolicy, error)
- func (d *Database) SecurityPoliciesContext(ctx context.Context) ([]*SecurityPolicy, error)
- func (d *Database) SecurityPolicyByName(schema, name string) (*SecurityPolicy, error)
- func (d *Database) SecurityPolicyByNameContext(ctx context.Context, schema, name string) (*SecurityPolicy, error)
- func (d *Database) SecurityPolicySeq(ctx context.Context) iter.Seq2[*SecurityPolicy, error]
- func (d *Database) SequenceSeq(ctx context.Context) iter.Seq2[*Sequence, error]
- func (d *Database) Sequences() ([]*Sequence, error)
- func (d *Database) SequencesContext(ctx context.Context) ([]*Sequence, error)
- func (d *Database) Server() *Server
- func (d *Database) SetChangeTracking(info ChangeTrackingInfo) error
- func (d *Database) SetChangeTrackingContext(ctx context.Context, info ChangeTrackingInfo) error
- func (d *Database) SetCompatibilityLevel(level CompatibilityLevel) error
- func (d *Database) SetCompatibilityLevelContext(ctx context.Context, level CompatibilityLevel) error
- func (d *Database) SetDatabaseOption(opt DatabaseOption, value string) error
- func (d *Database) SetDatabaseOptionContext(ctx context.Context, opt DatabaseOption, value string) error
- func (d *Database) SetDatabaseScopedConfig(name, value string, forSecondary bool) error
- func (d *Database) SetDatabaseScopedConfigContext(ctx context.Context, name, value string, forSecondary bool) error
- func (d *Database) SetDefaultFileGroup(name string) error
- func (d *Database) SetDefaultFileGroupContext(ctx context.Context, name string) error
- func (d *Database) SetExtendedProperty(name, value string, level ExtendedPropertyLevel) error
- func (d *Database) SetExtendedPropertyContext(ctx context.Context, name, value string, level ExtendedPropertyLevel) error
- func (d *Database) SetFileGroupReadOnly(name string, readOnly bool) error
- func (d *Database) SetFileGroupReadOnlyContext(ctx context.Context, name string, readOnly bool) error
- func (d *Database) SetOffline() error
- func (d *Database) SetOfflineContext(ctx context.Context) error
- func (d *Database) SetOnline() error
- func (d *Database) SetOnlineContext(ctx context.Context) error
- func (d *Database) SetOwner(principal string) error
- func (d *Database) SetOwnerContext(ctx context.Context, principal string) error
- func (d *Database) SetQueryStoreOptions(opts QueryStoreOptions) error
- func (d *Database) SetQueryStoreOptionsContext(ctx context.Context, opts QueryStoreOptions) error
- func (d *Database) SetReadOnly(readOnly bool) error
- func (d *Database) SetReadOnlyContext(ctx context.Context, readOnly bool) error
- func (d *Database) SetRecoveryModel(model RecoveryModel) error
- func (d *Database) SetRecoveryModelContext(ctx context.Context, model RecoveryModel) error
- func (d *Database) SetTableChangeTracking(schema, name string, enable, trackColumns bool) error
- func (d *Database) SetTableChangeTrackingContext(ctx context.Context, schema, name string, enable, trackColumns bool) error
- func (d *Database) SetUserAccess(mode string) error
- func (d *Database) SetUserAccessContext(ctx context.Context, mode string) error
- func (d *Database) SpaceUsed() (SpaceInfo, error)
- func (d *Database) SpaceUsedContext(ctx context.Context) (SpaceInfo, error)
- func (d *Database) State() string
- func (d *Database) StoredProcedureSeq(ctx context.Context) iter.Seq2[*StoredProcedure, error]
- func (d *Database) StoredProcedures() ([]*StoredProcedure, error)
- func (d *Database) StoredProceduresContext(ctx context.Context) ([]*StoredProcedure, error)
- func (d *Database) StoredProceduresFiltered(filter ObjectFilter) ([]*StoredProcedure, error)
- func (d *Database) StoredProceduresFilteredContext(ctx context.Context, filter ObjectFilter) ([]*StoredProcedure, error)
- func (d *Database) SynonymSeq(ctx context.Context) iter.Seq2[*Synonym, error]
- func (d *Database) Synonyms() ([]*Synonym, error)
- func (d *Database) SynonymsContext(ctx context.Context) ([]*Synonym, error)
- func (d *Database) SystemCatalog() (*Catalog, error)
- func (d *Database) SystemCatalogContext(ctx context.Context) (*Catalog, error)
- func (d *Database) SystemFunctionSeq(ctx context.Context) iter.Seq2[*UserDefinedFunction, error]
- func (d *Database) SystemFunctions() ([]*UserDefinedFunction, error)
- func (d *Database) SystemFunctionsContext(ctx context.Context) ([]*UserDefinedFunction, error)
- func (d *Database) SystemFunctionsFiltered(filter ObjectFilter) ([]*UserDefinedFunction, error)
- func (d *Database) SystemFunctionsFilteredContext(ctx context.Context, filter ObjectFilter) ([]*UserDefinedFunction, error)
- func (d *Database) SystemStoredProcedureSeq(ctx context.Context) iter.Seq2[*StoredProcedure, error]
- func (d *Database) SystemStoredProcedures() ([]*StoredProcedure, error)
- func (d *Database) SystemStoredProceduresContext(ctx context.Context) ([]*StoredProcedure, error)
- func (d *Database) SystemStoredProceduresFiltered(filter ObjectFilter) ([]*StoredProcedure, error)
- func (d *Database) SystemStoredProceduresFilteredContext(ctx context.Context, filter ObjectFilter) ([]*StoredProcedure, error)
- func (d *Database) SystemViewSeq(ctx context.Context) iter.Seq2[*View, error]
- func (d *Database) SystemViews() ([]*View, error)
- func (d *Database) SystemViewsContext(ctx context.Context) ([]*View, error)
- func (d *Database) SystemViewsFiltered(filter ObjectFilter) ([]*View, error)
- func (d *Database) SystemViewsFilteredContext(ctx context.Context, filter ObjectFilter) ([]*View, error)
- func (d *Database) Table(schema, name string) *Table
- func (d *Database) TableByName(schema, name string) (*Table, error)
- func (d *Database) TableByNameContext(ctx context.Context, schema, name string) (*Table, error)
- func (d *Database) TableChangeTracking() ([]*TableChangeTracking, error)
- func (d *Database) TableChangeTrackingContext(ctx context.Context) ([]*TableChangeTracking, error)
- func (d *Database) TableChangeTrackingFor(schema, name string) (*TableChangeTracking, error)
- func (d *Database) TableChangeTrackingForContext(ctx context.Context, schema, name string) (*TableChangeTracking, error)
- func (d *Database) TableChangeTrackingSeq(ctx context.Context) iter.Seq2[*TableChangeTracking, error]
- func (d *Database) TableRowCounts() (map[int]int64, error)
- func (d *Database) TableRowCountsContext(ctx context.Context) (map[int]int64, error)
- func (d *Database) TableSeq(ctx context.Context) iter.Seq2[*Table, error]
- func (d *Database) TableSpaceUsedAll() (map[int]*TableSpaceInfo, error)
- func (d *Database) TableSpaceUsedAllContext(ctx context.Context) (map[int]*TableSpaceInfo, error)
- func (d *Database) Tables() ([]*Table, error)
- func (d *Database) TablesBySchema(schema string) ([]*Table, error)
- func (d *Database) TablesBySchemaContext(ctx context.Context, schema string) ([]*Table, error)
- func (d *Database) TablesBySchemaSeq(ctx context.Context, schema string) iter.Seq2[*Table, error]
- func (d *Database) TablesContext(ctx context.Context) ([]*Table, error)
- func (d *Database) TablesFiltered(filter ObjectFilter) ([]*Table, error)
- func (d *Database) TablesFilteredContext(ctx context.Context, filter ObjectFilter) ([]*Table, error)
- func (d *Database) TransferObject(targetSchema, schema, name string) error
- func (d *Database) TransferObjectContext(ctx context.Context, targetSchema, schema, name string) error
- func (d *Database) TriggerSeq(ctx context.Context) iter.Seq2[*Trigger, error]
- func (d *Database) Triggers() ([]*Trigger, error)
- func (d *Database) TriggersContext(ctx context.Context) ([]*Trigger, error)
- func (d *Database) UserByName(name string) (*User, error)
- func (d *Database) UserByNameContext(ctx context.Context, name string) (*User, error)
- func (d *Database) UserDefinedFunctionSeq(ctx context.Context) iter.Seq2[*UserDefinedFunction, error]
- func (d *Database) UserDefinedFunctions() ([]*UserDefinedFunction, error)
- func (d *Database) UserDefinedFunctionsContext(ctx context.Context) ([]*UserDefinedFunction, error)
- func (d *Database) UserDefinedFunctionsFiltered(filter ObjectFilter) ([]*UserDefinedFunction, error)
- func (d *Database) UserDefinedFunctionsFilteredContext(ctx context.Context, filter ObjectFilter) ([]*UserDefinedFunction, error)
- func (d *Database) UserSeq(ctx context.Context) iter.Seq2[*User, error]
- func (d *Database) Users() ([]*User, error)
- func (d *Database) UsersContext(ctx context.Context) ([]*User, error)
- func (d *Database) ViewSeq(ctx context.Context) iter.Seq2[*View, error]
- func (d *Database) Views() ([]*View, error)
- func (d *Database) ViewsContext(ctx context.Context) ([]*View, error)
- func (d *Database) ViewsFiltered(filter ObjectFilter) ([]*View, error)
- func (d *Database) ViewsFilteredContext(ctx context.Context, filter ObjectFilter) ([]*View, error)
- type DatabaseCapabilities
- type DatabaseFile
- type DatabaseFileInfo
- type DatabaseFileSpec
- type DatabaseMirroringEndpoint
- func (e *DatabaseMirroringEndpoint) Drop() error
- func (e *DatabaseMirroringEndpoint) DropContext(ctx context.Context) error
- func (e *DatabaseMirroringEndpoint) GrantConnect(login string) error
- func (e *DatabaseMirroringEndpoint) GrantConnectContext(ctx context.Context, login string) error
- func (e *DatabaseMirroringEndpoint) Server() *Server
- func (e *DatabaseMirroringEndpoint) Start() error
- func (e *DatabaseMirroringEndpoint) StartContext(ctx context.Context) error
- func (e *DatabaseMirroringEndpoint) Stop() error
- func (e *DatabaseMirroringEndpoint) StopContext(ctx context.Context) error
- func (e *DatabaseMirroringEndpoint) URL() string
- type DatabaseOption
- type DatabaseOptions
- type DatabasePermissionEntry
- type DatabaseRecoveryStatus
- type DatabaseRole
- func (r *DatabaseRole) ChangeOwner(newOwner string) error
- func (r *DatabaseRole) ChangeOwnerContext(ctx context.Context, newOwner string) error
- func (r *DatabaseRole) Drop() error
- func (r *DatabaseRole) DropContext(ctx context.Context) error
- func (r *DatabaseRole) Rename(newName string) error
- func (r *DatabaseRole) RenameContext(ctx context.Context, newName string) error
- type DatabaseScopedConfig
- type DateCriterion
- type DateOp
- type Dependency
- type DiskVolumeInfo
- type EffectivePermission
- type EndpointSpec
- type ErrorLogEntry
- type ErrorLogFile
- type ErrorLogType
- type ExecutionPlan
- type ExtendedProperty
- type ExtendedPropertyLevel
- type FileGroup
- type FileModify
- type FileSystemEntry
- type FixedDrive
- type ForeignKey
- type Index
- func (idx *Index) Disable(t *Table) error
- func (idx *Index) DisableContext(ctx context.Context, t *Table) error
- func (idx *Index) Drop(t *Table) error
- func (idx *Index) DropContext(ctx context.Context, t *Table) error
- func (idx *Index) Enable(t *Table) error
- func (idx *Index) EnableContext(ctx context.Context, t *Table) error
- func (idx *Index) Fragmentation(t *Table, mode string) (*IndexFragmentation, error)
- func (idx *Index) FragmentationContext(ctx context.Context, t *Table, mode string) (*IndexFragmentation, error)
- func (idx *Index) Rebuild(t *Table, fillFactor int) error
- func (idx *Index) RebuildContext(ctx context.Context, t *Table, fillFactor int) error
- func (idx *Index) RebuildWithOptions(t *Table, fillFactor int, padIndex bool, dataCompression string) error
- func (idx *Index) RebuildWithOptionsContext(ctx context.Context, t *Table, fillFactor int, padIndex bool, ...) error
- func (idx *Index) Rename(t *Table, newName string) error
- func (idx *Index) RenameContext(ctx context.Context, t *Table, newName string) error
- func (idx *Index) Reorganize(t *Table) error
- func (idx *Index) ReorganizeContext(ctx context.Context, t *Table) error
- func (idx *Index) SetIncludedColumns(t *Table, columns []string) error
- func (idx *Index) SetIncludedColumnsContext(ctx context.Context, t *Table, columns []string) error
- func (idx *Index) SetLockOptions(t *Table, allowRowLocks, allowPageLocks bool) error
- func (idx *Index) SetLockOptionsContext(ctx context.Context, t *Table, allowRowLocks, allowPageLocks bool) error
- func (idx *Index) SetOptions(t *Table, ignoreDupKey, allowRowLocks, allowPageLocks bool) error
- func (idx *Index) SetOptionsContext(ctx context.Context, t *Table, ...) error
- func (idx *Index) StorageInfo(t *Table) (*IndexStorageInfo, error)
- func (idx *Index) StorageInfoContext(ctx context.Context, t *Table) (*IndexStorageInfo, error)
- func (idx *Index) UpdateStatistics(t *Table) error
- func (idx *Index) UpdateStatisticsContext(ctx context.Context, t *Table) error
- type IndexAllocationUnit
- type IndexColumn
- type IndexColumnDef
- type IndexFragmentation
- type IndexStorageInfo
- type IndexType
- type Job
- func (j *Job) AddSchedule(req JobScheduleRequest) error
- func (j *Job) AddScheduleContext(ctx context.Context, req JobScheduleRequest) error
- func (j *Job) AddStep(req JobStepRequest) error
- func (j *Job) AddStepContext(ctx context.Context, req JobStepRequest) error
- func (j *Job) AttachSchedule(scheduleName string) error
- func (j *Job) AttachScheduleContext(ctx context.Context, scheduleName string) error
- func (j *Job) DetachSchedule(scheduleName string) error
- func (j *Job) DetachScheduleContext(ctx context.Context, scheduleName string) error
- func (j *Job) Disable() error
- func (j *Job) DisableContext(ctx context.Context) error
- func (j *Job) Drop() error
- func (j *Job) DropContext(ctx context.Context) error
- func (j *Job) Enable() error
- func (j *Job) EnableContext(ctx context.Context) error
- func (j *Job) History(limit int) ([]*JobHistoryEntry, error)
- func (j *Job) HistoryContext(ctx context.Context, limit int) ([]*JobHistoryEntry, error)
- func (j *Job) HistorySeq(ctx context.Context, limit int) iter.Seq2[*JobHistoryEntry, error]
- func (j *Job) InsertStep(req JobStepRequest, stepID int) error
- func (j *Job) InsertStepContext(ctx context.Context, req JobStepRequest, stepID int) error
- func (j *Job) MoveStep(stepID, newStepID int) error
- func (j *Job) MoveStepContext(ctx context.Context, stepID, newStepID int) error
- func (j *Job) Rename(newName string) error
- func (j *Job) RenameContext(ctx context.Context, newName string) error
- func (j *Job) ReorderSteps(order func(n int) []int) error
- func (j *Job) ReorderStepsContext(ctx context.Context, order func(n int) []int) error
- func (j *Job) ScheduleSeq(ctx context.Context) iter.Seq2[*Schedule, error]
- func (j *Job) Schedules() ([]*Schedule, error)
- func (j *Job) SchedulesContext(ctx context.Context) ([]*Schedule, error)
- func (j *Job) SetCategory(category string) error
- func (j *Job) SetCategoryContext(ctx context.Context, category string) error
- func (j *Job) SetDeleteLevel(level NotifyLevel) error
- func (j *Job) SetDeleteLevelContext(ctx context.Context, level NotifyLevel) error
- func (j *Job) SetDescription(desc string) error
- func (j *Job) SetDescriptionContext(ctx context.Context, desc string) error
- func (j *Job) SetEmailNotify(operatorName string, level NotifyLevel) error
- func (j *Job) SetEmailNotifyContext(ctx context.Context, operatorName string, level NotifyLevel) error
- func (j *Job) SetOwner(loginName string) error
- func (j *Job) SetOwnerContext(ctx context.Context, loginName string) error
- func (j *Job) SetStartStep(stepID int) error
- func (j *Job) SetStartStepContext(ctx context.Context, stepID int) error
- func (j *Job) Start(stepName string) error
- func (j *Job) StartContext(ctx context.Context, stepName string) error
- func (j *Job) StepSeq(ctx context.Context) iter.Seq2[*JobStep, error]
- func (j *Job) Steps() ([]*JobStep, error)
- func (j *Job) StepsContext(ctx context.Context) ([]*JobStep, error)
- func (j *Job) Stop() error
- func (j *Job) StopContext(ctx context.Context) error
- type JobHistoryEntry
- type JobNotificationRef
- type JobOutcome
- type JobScheduleRequest
- type JobState
- type JobStep
- func (s *JobStep) Delete() error
- func (s *JobStep) DeleteContext(ctx context.Context) error
- func (s *JobStep) SetFlow(onSuccessAction, onSuccessStepID, onFailAction, onFailStepID int) error
- func (s *JobStep) SetFlowContext(ctx context.Context, ...) error
- func (s *JobStep) Update(req JobStepRequest) error
- func (s *JobStep) UpdateContext(ctx context.Context, req JobStepRequest) error
- type JobStepRequest
- type KerberosOptions
- type Language
- type LinkedServer
- type LogSearch
- type Login
- func (l *Login) AddServerRoleMember(roleName string) error
- func (l *Login) AddServerRoleMemberContext(ctx context.Context, roleName string) error
- func (l *Login) ChangePassword(newPassword string) error
- func (l *Login) ChangePasswordContext(ctx context.Context, newPassword string) error
- func (l *Login) ChangePasswordWithOptions(newPassword string, mustChange, unlock bool) error
- func (l *Login) ChangePasswordWithOptionsContext(ctx context.Context, newPassword string, mustChange, unlock bool) error
- func (l *Login) Details() (*LoginDetails, error)
- func (l *Login) DetailsContext(ctx context.Context) (*LoginDetails, error)
- func (l *Login) Disable() error
- func (l *Login) DisableContext(ctx context.Context) error
- func (l *Login) Drop() error
- func (l *Login) DropContext(ctx context.Context) error
- func (l *Login) Enable() error
- func (l *Login) EnableContext(ctx context.Context) error
- func (l *Login) MapCredential(credential string) error
- func (l *Login) MapCredentialContext(ctx context.Context, credential string) error
- func (l *Login) MapToDatabase(dbName, userName, defaultSchema string) error
- func (l *Login) MapToDatabaseContext(ctx context.Context, dbName, userName, defaultSchema string) error
- func (l *Login) RemoveServerRoleMember(roleName string) error
- func (l *Login) RemoveServerRoleMemberContext(ctx context.Context, roleName string) error
- func (l *Login) Rename(newName string) error
- func (l *Login) RenameContext(ctx context.Context, newName string) error
- func (l *Login) ResolveMapping() error
- func (l *Login) ResolveMappingContext(ctx context.Context) error
- func (l *Login) SetDefaultDatabase(name string) error
- func (l *Login) SetDefaultDatabaseContext(ctx context.Context, name string) error
- func (l *Login) SetDefaultLanguage(lang string) error
- func (l *Login) SetDefaultLanguageContext(ctx context.Context, lang string) error
- func (l *Login) SetPasswordPolicy(checkPolicy, checkExpiration bool) error
- func (l *Login) SetPasswordPolicyContext(ctx context.Context, checkPolicy, checkExpiration bool) error
- func (l *Login) UnmapCredential(credential string) error
- func (l *Login) UnmapCredentialContext(ctx context.Context, credential string) error
- func (l *Login) UnmapFromDatabase(dbName string) error
- func (l *Login) UnmapFromDatabaseContext(ctx context.Context, dbName string) error
- func (l *Login) UserMappingSeq(ctx context.Context) iter.Seq2[*LoginUserMapping, error]
- func (l *Login) UserMappings() ([]*LoginUserMapping, error)
- func (l *Login) UserMappingsContext(ctx context.Context) ([]*LoginUserMapping, error)
- type LoginDetails
- type LoginSource
- type LoginUserMapping
- type MailProfile
- type NotificationMethod
- type NotifyLevel
- type ObjectFilter
- type ObjectPermission
- type Operator
- func (o *Operator) Disable() error
- func (o *Operator) DisableContext(ctx context.Context) error
- func (o *Operator) Drop() error
- func (o *Operator) DropContext(ctx context.Context) error
- func (o *Operator) Enable() error
- func (o *Operator) EnableContext(ctx context.Context) error
- func (o *Operator) NotifyingAlertSeq(ctx context.Context) iter.Seq2[*AlertNotificationRef, error]
- func (o *Operator) NotifyingAlerts() ([]*AlertNotificationRef, error)
- func (o *Operator) NotifyingAlertsContext(ctx context.Context) ([]*AlertNotificationRef, error)
- func (o *Operator) NotifyingJobSeq(ctx context.Context) iter.Seq2[*JobNotificationRef, error]
- func (o *Operator) NotifyingJobs() ([]*JobNotificationRef, error)
- func (o *Operator) NotifyingJobsContext(ctx context.Context) ([]*JobNotificationRef, error)
- func (o *Operator) Rename(newName string) error
- func (o *Operator) RenameContext(ctx context.Context, newName string) error
- func (o *Operator) SetCategory(category string) error
- func (o *Operator) SetCategoryContext(ctx context.Context, category string) error
- func (o *Operator) SetEmailAddress(addr string) error
- func (o *Operator) SetEmailAddressContext(ctx context.Context, addr string) error
- type Parameter
- type PartitionFunction
- func (pf *PartitionFunction) Drop() error
- func (pf *PartitionFunction) DropContext(ctx context.Context) error
- func (pf *PartitionFunction) MergeRange(value string) error
- func (pf *PartitionFunction) MergeRangeContext(ctx context.Context, value string) error
- func (pf *PartitionFunction) SplitRange(value string) error
- func (pf *PartitionFunction) SplitRangeContext(ctx context.Context, value string) error
- type PartitionInfo
- type PartitionScheme
- type PermissionEntry
- type PermissionOptions
- type PermissionState
- type PrincipalSecurable
- type ProcParam
- type ProcResult
- type ProcessorInfo
- type QueryStoreInfo
- type QueryStoreOptions
- type RecoveryModel
- type RelocateFile
- type RestoreOptions
- type RoleMember
- type SQLError
- type Schedule
- func (sch *Schedule) Description() string
- func (sch *Schedule) Disable() error
- func (sch *Schedule) DisableContext(ctx context.Context) error
- func (sch *Schedule) Drop() error
- func (sch *Schedule) DropContext(ctx context.Context) error
- func (sch *Schedule) Enable() error
- func (sch *Schedule) EnableContext(ctx context.Context) error
- func (sch *Schedule) JobSeq(ctx context.Context) iter.Seq2[*Job, error]
- func (sch *Schedule) Jobs() ([]*Job, error)
- func (sch *Schedule) JobsContext(ctx context.Context) ([]*Job, error)
- func (sch *Schedule) Rename(newName string) error
- func (sch *Schedule) RenameContext(ctx context.Context, newName string) error
- func (sch *Schedule) SetActiveRange(startDate, endDate time.Time, startTime, endTime int) error
- func (sch *Schedule) SetActiveRangeContext(ctx context.Context, startDate, endDate time.Time, startTime, endTime int) error
- func (sch *Schedule) SetFrequency(f ScheduleFrequency) error
- func (sch *Schedule) SetFrequencyContext(ctx context.Context, f ScheduleFrequency) error
- func (sch *Schedule) SetOwner(loginName string) error
- func (sch *Schedule) SetOwnerContext(ctx context.Context, loginName string) error
- type ScheduleFreqType
- type ScheduleFrequency
- type ScheduleSubdayType
- type Schema
- func (s *Schema) ChangeOwner(newOwner string) error
- func (s *Schema) ChangeOwnerContext(ctx context.Context, newOwner string) error
- func (s *Schema) Drop() error
- func (s *Schema) DropContext(ctx context.Context) error
- func (s *Schema) ObjectCount() (int, error)
- func (s *Schema) ObjectCountContext(ctx context.Context) (int, error)
- func (s *Schema) ObjectCountsByType() (SchemaObjectCounts, error)
- func (s *Schema) ObjectCountsByTypeContext(ctx context.Context) (SchemaObjectCounts, error)
- type SchemaObjectCounts
- type ScriptCollector
- type ScriptOptions
- type ScriptVerb
- type Scripter
- func (sc *Scripter) ScriptCheckConstraint(schema, table, name string) (string, error)
- func (sc *Scripter) ScriptCheckConstraintContext(ctx context.Context, schema, table, name string) (string, error)
- func (sc *Scripter) ScriptColumnEncryptionKey(name string) (string, error)
- func (sc *Scripter) ScriptColumnEncryptionKeyContext(ctx context.Context, name string) (string, error)
- func (sc *Scripter) ScriptColumnMasterKey(name string) (string, error)
- func (sc *Scripter) ScriptColumnMasterKeyContext(ctx context.Context, name string) (string, error)
- func (sc *Scripter) ScriptDatabase() (string, error)
- func (sc *Scripter) ScriptDatabaseContext(ctx context.Context) (string, error)
- func (sc *Scripter) ScriptDatabaseRole(name string) (string, error)
- func (sc *Scripter) ScriptDatabaseRoleContext(ctx context.Context, name string) (string, error)
- func (sc *Scripter) ScriptDelete(schema, name string) (string, error)
- func (sc *Scripter) ScriptDeleteContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptExecute(schema, name string) (string, error)
- func (sc *Scripter) ScriptExecuteContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptForeignKey(schema, table, name string) (string, error)
- func (sc *Scripter) ScriptForeignKeyContext(ctx context.Context, schema, table, name string) (string, error)
- func (sc *Scripter) ScriptFunction(schema, name string) (string, error)
- func (sc *Scripter) ScriptFunctionCall(schema, name, funcType string) (string, error)
- func (sc *Scripter) ScriptFunctionCallContext(ctx context.Context, schema, name, funcType string) (string, error)
- func (sc *Scripter) ScriptFunctionContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptIndex(schema, table, name string) (string, error)
- func (sc *Scripter) ScriptIndexContext(ctx context.Context, schema, table, name string) (string, error)
- func (sc *Scripter) ScriptInsert(schema, name string) (string, error)
- func (sc *Scripter) ScriptInsertContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptPartitionFunction(name string) (string, error)
- func (sc *Scripter) ScriptPartitionFunctionContext(ctx context.Context, name string) (string, error)
- func (sc *Scripter) ScriptPartitionScheme(name string) (string, error)
- func (sc *Scripter) ScriptPartitionSchemeContext(ctx context.Context, name string) (string, error)
- func (sc *Scripter) ScriptSchema(name string) (string, error)
- func (sc *Scripter) ScriptSchemaContext(ctx context.Context, name string) (string, error)
- func (sc *Scripter) ScriptSecurityPolicy(schema, name string) (string, error)
- func (sc *Scripter) ScriptSecurityPolicyContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptSelect(schema, name string) (string, error)
- func (sc *Scripter) ScriptSelectContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptSequence(schema, name string) (string, error)
- func (sc *Scripter) ScriptSequenceContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptStoredProcedure(schema, name string) (string, error)
- func (sc *Scripter) ScriptStoredProcedureContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptSynonym(schema, name string) (string, error)
- func (sc *Scripter) ScriptSynonymContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptTable(schema, name string) (string, error)
- func (sc *Scripter) ScriptTableContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptTrigger(schema, name string) (string, error)
- func (sc *Scripter) ScriptTriggerContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptUpdate(schema, name string) (string, error)
- func (sc *Scripter) ScriptUpdateContext(ctx context.Context, schema, name string) (string, error)
- func (sc *Scripter) ScriptUser(name string) (string, error)
- func (sc *Scripter) ScriptUserContext(ctx context.Context, name string) (string, error)
- func (sc *Scripter) ScriptView(schema, name string) (string, error)
- func (sc *Scripter) ScriptViewContext(ctx context.Context, schema, name string) (string, error)
- type SearchResult
- type SecurableRef
- type SecurableSearch
- type SecurityPolicy
- func (p *SecurityPolicy) Disable() error
- func (p *SecurityPolicy) DisableContext(ctx context.Context) error
- func (p *SecurityPolicy) Drop() error
- func (p *SecurityPolicy) DropContext(ctx context.Context) error
- func (p *SecurityPolicy) Enable() error
- func (p *SecurityPolicy) EnableContext(ctx context.Context) error
- type SecurityPredicate
- type Sequence
- func (seq *Sequence) Drop() error
- func (seq *Sequence) DropContext(ctx context.Context) error
- func (seq *Sequence) NextValue() (int64, error)
- func (seq *Sequence) NextValueContext(ctx context.Context) (int64, error)
- func (seq *Sequence) Restart(value int64) error
- func (seq *Sequence) RestartContext(ctx context.Context, value int64) error
- type Server
- func (s *Server) ActiveSessionSeq(ctx context.Context, includeSystem bool) iter.Seq2[*ActiveSession, error]
- func (s *Server) ActiveSessions(includeSystem bool) ([]*ActiveSession, error)
- func (s *Server) ActiveSessionsContext(ctx context.Context, includeSystem bool) ([]*ActiveSession, error)
- func (s *Server) AddServerRoleMember(roleName, memberName string) error
- func (s *Server) AddServerRoleMemberContext(ctx context.Context, roleName, memberName string) error
- func (s *Server) AgentInfo() (*AgentStatus, error)
- func (s *Server) AgentInfoContext(ctx context.Context) (*AgentStatus, error)
- func (s *Server) Alert(name string) *Alert
- func (s *Server) AlertByName(name string) (*Alert, error)
- func (s *Server) AlertByNameContext(ctx context.Context, name string) (*Alert, error)
- func (s *Server) AlertSeq(ctx context.Context) iter.Seq2[*Alert, error]
- func (s *Server) Alerts() ([]*Alert, error)
- func (s *Server) AlertsContext(ctx context.Context) ([]*Alert, error)
- func (s *Server) AvailabilityGroup(name string) *AvailabilityGroup
- func (s *Server) AvailabilityGroupByName(name string) (*AvailabilityGroup, error)
- func (s *Server) AvailabilityGroupByNameContext(ctx context.Context, name string) (*AvailabilityGroup, error)
- func (s *Server) AvailabilityGroupSeq(ctx context.Context) iter.Seq2[*AvailabilityGroup, error]
- func (s *Server) AvailabilityGroups() ([]*AvailabilityGroup, error)
- func (s *Server) AvailabilityGroupsContext(ctx context.Context) ([]*AvailabilityGroup, error)
- func (s *Server) Backup(opts BackupOptions) error
- func (s *Server) BackupContext(ctx context.Context, opts BackupOptions) error
- func (s *Server) BackupFileList(device string) ([]*BackupFile, error)
- func (s *Server) BackupFileListContext(ctx context.Context, device string) ([]*BackupFile, error)
- func (s *Server) BackupFileListForSet(device string, fileNumber int) ([]*BackupFile, error)
- func (s *Server) BackupFileListForSetContext(ctx context.Context, device string, fileNumber int) ([]*BackupFile, error)
- func (s *Server) BackupFileSeq(ctx context.Context, device string) iter.Seq2[*BackupFile, error]
- func (s *Server) BackupHeaderSeq(ctx context.Context, device string) iter.Seq2[*BackupHeader, error]
- func (s *Server) BackupHeaders(device string) ([]*BackupHeader, error)
- func (s *Server) BackupHeadersContext(ctx context.Context, device string) ([]*BackupHeader, error)
- func (s *Server) BackupHistory(databaseName string) ([]*BackupInfo, error)
- func (s *Server) BackupHistoryContext(ctx context.Context, databaseName string) ([]*BackupInfo, error)
- func (s *Server) BackupHistorySeq(ctx context.Context, databaseName string) iter.Seq2[*BackupInfo, error]
- func (s *Server) Capabilities() (*Capabilities, error)
- func (s *Server) CapabilitiesContext(ctx context.Context) (*Capabilities, error)
- func (s *Server) Categories(class CategoryClass) ([]*Category, error)
- func (s *Server) CategoriesContext(ctx context.Context, class CategoryClass) ([]*Category, error)
- func (s *Server) CategorySeq(ctx context.Context, class CategoryClass) iter.Seq2[*Category, error]
- func (s *Server) Close() error
- func (s *Server) ConfigurationByName(name string) (*ConfigurationOption, error)
- func (s *Server) ConfigurationByNameContext(ctx context.Context, name string) (*ConfigurationOption, error)
- func (s *Server) ConfigurationSeq(ctx context.Context) iter.Seq2[*ConfigurationOption, error]
- func (s *Server) Configurations() ([]*ConfigurationOption, error)
- func (s *Server) ConfigurationsContext(ctx context.Context) ([]*ConfigurationOption, error)
- func (s *Server) CreateAlert(req CreateAlertRequest) (*Alert, error)
- func (s *Server) CreateAlertContext(ctx context.Context, req CreateAlertRequest) (*Alert, error)
- func (s *Server) CreateAvailabilityGroup(req CreateAvailabilityGroupRequest) (*AvailabilityGroup, error)
- func (s *Server) CreateAvailabilityGroupContext(ctx context.Context, req CreateAvailabilityGroupRequest) (*AvailabilityGroup, error)
- func (s *Server) CreateCategory(class CategoryClass, name string) error
- func (s *Server) CreateCategoryContext(ctx context.Context, class CategoryClass, name string) error
- func (s *Server) CreateDatabase(name string, opts *CreateDatabaseOptions) error
- func (s *Server) CreateDatabaseContext(ctx context.Context, name string, opts *CreateDatabaseOptions) error
- func (s *Server) CreateDatabaseMirroringEndpoint(spec EndpointSpec) (*DatabaseMirroringEndpoint, error)
- func (s *Server) CreateDatabaseMirroringEndpointContext(ctx context.Context, spec EndpointSpec) (*DatabaseMirroringEndpoint, error)
- func (s *Server) CreateJob(req CreateJobRequest) (*Job, error)
- func (s *Server) CreateJobContext(ctx context.Context, req CreateJobRequest) (*Job, error)
- func (s *Server) CreateLogin(name, password string, opts *CreateLoginOptions) error
- func (s *Server) CreateLoginContext(ctx context.Context, name, password string, opts *CreateLoginOptions) error
- func (s *Server) CreateOperator(req CreateOperatorRequest) (*Operator, error)
- func (s *Server) CreateOperatorContext(ctx context.Context, req CreateOperatorRequest) (*Operator, error)
- func (s *Server) CreateSchedule(req CreateScheduleRequest) (*Schedule, error)
- func (s *Server) CreateScheduleContext(ctx context.Context, req CreateScheduleRequest) (*Schedule, error)
- func (s *Server) CredentialSeq(ctx context.Context) iter.Seq2[*Credential, error]
- func (s *Server) Credentials() ([]*Credential, error)
- func (s *Server) CredentialsContext(ctx context.Context) ([]*Credential, error)
- func (s *Server) CurrentDatabase() (string, error)
- func (s *Server) CurrentDatabaseContext(ctx context.Context) (string, error)
- func (s *Server) CurrentLogin() (string, error)
- func (s *Server) CurrentLoginContext(ctx context.Context) (string, error)
- func (s *Server) CycleErrorLog() error
- func (s *Server) CycleErrorLogContext(ctx context.Context) error
- func (s *Server) CycleLog(logType ErrorLogType) error
- func (s *Server) CycleLogContext(ctx context.Context, logType ErrorLogType) error
- func (s *Server) DB() *sql.DB
- func (s *Server) Database(name string) *Database
- func (s *Server) DatabaseByName(name string) (*Database, error)
- func (s *Server) DatabaseByNameContext(ctx context.Context, name string) (*Database, error)
- func (s *Server) DatabaseMirroringEndpoint() (*DatabaseMirroringEndpoint, error)
- func (s *Server) DatabaseMirroringEndpointContext(ctx context.Context) (*DatabaseMirroringEndpoint, error)
- func (s *Server) DatabaseRecoveryStatuses() ([]*DatabaseRecoveryStatus, error)
- func (s *Server) DatabaseRecoveryStatusesContext(ctx context.Context) ([]*DatabaseRecoveryStatus, error)
- func (s *Server) DatabaseSeq(ctx context.Context) iter.Seq2[*Database, error]
- func (s *Server) Databases() ([]*Database, error)
- func (s *Server) DatabasesContext(ctx context.Context) ([]*Database, error)
- func (s *Server) DeleteCategory(class CategoryClass, name string) error
- func (s *Server) DeleteCategoryContext(ctx context.Context, class CategoryClass, name string) error
- func (s *Server) DenyServerPermission(permission, principal string) error
- func (s *Server) DenyServerPermissionContext(ctx context.Context, permission, principal string) error
- func (s *Server) DenyServerPermissionWithOptions(permission, principal string, opts PermissionOptions) error
- func (s *Server) DenyServerPermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
- func (s *Server) DiskVolumeSeq(ctx context.Context) iter.Seq2[DiskVolumeInfo, error]
- func (s *Server) DiskVolumes() ([]DiskVolumeInfo, error)
- func (s *Server) DiskVolumesContext(ctx context.Context) ([]DiskVolumeInfo, error)
- func (s *Server) DropDatabase(name string, force bool) error
- func (s *Server) DropDatabaseContext(ctx context.Context, name string, force bool) error
- func (s *Server) DropLogin(name string) error
- func (s *Server) DropLoginContext(ctx context.Context, name string) error
- func (s *Server) DropServerRole(name string) error
- func (s *Server) DropServerRoleContext(ctx context.Context, name string) error
- func (s *Server) EffectiveServerPermissionSeq(ctx context.Context, login string) iter.Seq2[*EffectivePermission, error]
- func (s *Server) EffectiveServerPermissions(login string) ([]*EffectivePermission, error)
- func (s *Server) EffectiveServerPermissionsContext(ctx context.Context, login string) ([]*EffectivePermission, error)
- func (s *Server) EnumErrorLogSeq(ctx context.Context, logType ErrorLogType) iter.Seq2[*ErrorLogFile, error]
- func (s *Server) EnumErrorLogs(logType ErrorLogType) ([]*ErrorLogFile, error)
- func (s *Server) EnumErrorLogsContext(ctx context.Context, logType ErrorLogType) ([]*ErrorLogFile, error)
- func (s *Server) EnumFileSystem(path string) ([]*FileSystemEntry, error)
- func (s *Server) EnumFileSystemContext(ctx context.Context, path string) ([]*FileSystemEntry, error)
- func (s *Server) EnumFileSystemIsLegacy() bool
- func (s *Server) EventAlertSeq(ctx context.Context) iter.Seq2[*Alert, error]
- func (s *Server) EventAlerts() ([]*Alert, error)
- func (s *Server) EventAlertsContext(ctx context.Context) ([]*Alert, error)
- func (s *Server) FileSystemExists(path string) (exists, isDirectory bool, err error)
- func (s *Server) FileSystemExistsContext(ctx context.Context, path string) (exists, isDirectory bool, err error)
- func (s *Server) FixedDrives() ([]*FixedDrive, error)
- func (s *Server) FixedDrivesContext(ctx context.Context) ([]*FixedDrive, error)
- func (s *Server) GrantServerPermission(permission, principal string) error
- func (s *Server) GrantServerPermissionContext(ctx context.Context, permission, principal string) error
- func (s *Server) GrantServerPermissionWithOptions(permission, principal string, opts PermissionOptions) error
- func (s *Server) GrantServerPermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
- func (s *Server) Info() *ServerInfo
- func (s *Server) Job(name string) *Job
- func (s *Server) JobByName(name string) (*Job, error)
- func (s *Server) JobByNameContext(ctx context.Context, name string) (*Job, error)
- func (s *Server) JobHistory(limit int) ([]*JobHistoryEntry, error)
- func (s *Server) JobHistoryContext(ctx context.Context, limit int) ([]*JobHistoryEntry, error)
- func (s *Server) JobHistorySeq(ctx context.Context, limit int) iter.Seq2[*JobHistoryEntry, error]
- func (s *Server) JobSeq(ctx context.Context) iter.Seq2[*Job, error]
- func (s *Server) Jobs() ([]*Job, error)
- func (s *Server) JobsContext(ctx context.Context) ([]*Job, error)
- func (s *Server) KillSession(sessionID int) error
- func (s *Server) KillSessionContext(ctx context.Context, sessionID int) error
- func (s *Server) LanguageSeq(ctx context.Context) iter.Seq2[*Language, error]
- func (s *Server) Languages() ([]*Language, error)
- func (s *Server) LanguagesContext(ctx context.Context) ([]*Language, error)
- func (s *Server) LinkedServerSeq(ctx context.Context) iter.Seq2[*LinkedServer, error]
- func (s *Server) LinkedServers() ([]*LinkedServer, error)
- func (s *Server) LinkedServersContext(ctx context.Context) ([]*LinkedServer, error)
- func (s *Server) Login(name string) *Login
- func (s *Server) LoginByName(name string) (*Login, error)
- func (s *Server) LoginByNameContext(ctx context.Context, name string) (*Login, error)
- func (s *Server) LoginSeq(ctx context.Context) iter.Seq2[*Login, error]
- func (s *Server) Logins() ([]*Login, error)
- func (s *Server) LoginsContext(ctx context.Context) ([]*Login, error)
- func (s *Server) MailProfileSeq(ctx context.Context) iter.Seq2[*MailProfile, error]
- func (s *Server) MailProfiles() ([]*MailProfile, error)
- func (s *Server) MailProfilesContext(ctx context.Context) ([]*MailProfile, error)
- func (s *Server) MemoryStats() (*ServerMemoryStats, error)
- func (s *Server) MemoryStatsContext(ctx context.Context) (*ServerMemoryStats, error)
- func (s *Server) Name() string
- func (s *Server) Operator(name string) *Operator
- func (s *Server) OperatorByName(name string) (*Operator, error)
- func (s *Server) OperatorByNameContext(ctx context.Context, name string) (*Operator, error)
- func (s *Server) OperatorSeq(ctx context.Context) iter.Seq2[*Operator, error]
- func (s *Server) Operators() ([]*Operator, error)
- func (s *Server) OperatorsContext(ctx context.Context) ([]*Operator, error)
- func (s *Server) ProcessorInfo() (*ProcessorInfo, error)
- func (s *Server) ProcessorInfoContext(ctx context.Context) (*ProcessorInfo, error)
- func (s *Server) ReadErrorLog(logNumber int) ([]*ErrorLogEntry, error)
- func (s *Server) ReadErrorLogContext(ctx context.Context, logNumber int) ([]*ErrorLogEntry, error)
- func (s *Server) ReadErrorLogSeq(ctx context.Context, logNumber int) iter.Seq2[*ErrorLogEntry, error]
- func (s *Server) ReadLog(logType ErrorLogType, logNumber int) ([]*ErrorLogEntry, error)
- func (s *Server) ReadLogContext(ctx context.Context, logType ErrorLogType, logNumber int) ([]*ErrorLogEntry, error)
- func (s *Server) ReadLogFiltered(logType ErrorLogType, logNumber int, search LogSearch) ([]*ErrorLogEntry, error)
- func (s *Server) ReadLogFilteredContext(ctx context.Context, logType ErrorLogType, logNumber int, search LogSearch) ([]*ErrorLogEntry, error)
- func (s *Server) ReadLogSeq(ctx context.Context, logType ErrorLogType, logNumber int) iter.Seq2[*ErrorLogEntry, error]
- func (s *Server) Reconfigure(override bool) error
- func (s *Server) ReconfigureContext(ctx context.Context, override bool) error
- func (s *Server) RemoveServerRoleMember(roleName, memberName string) error
- func (s *Server) RemoveServerRoleMemberContext(ctx context.Context, roleName, memberName string) error
- func (s *Server) RenameDatabase(oldName, newName string, force bool) error
- func (s *Server) RenameDatabaseContext(ctx context.Context, oldName, newName string, force bool) error
- func (s *Server) Restore(opts RestoreOptions) error
- func (s *Server) RestoreContext(ctx context.Context, opts RestoreOptions) error
- func (s *Server) RevokeServerPermission(permission, principal string) error
- func (s *Server) RevokeServerPermissionContext(ctx context.Context, permission, principal string) error
- func (s *Server) RevokeServerPermissionWithOptions(permission, principal string, opts PermissionOptions) error
- func (s *Server) RevokeServerPermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
- func (s *Server) Schedule(name string) *Schedule
- func (s *Server) ScheduleByName(name string) (*Schedule, error)
- func (s *Server) ScheduleByNameContext(ctx context.Context, name string) (*Schedule, error)
- func (s *Server) ScheduleSeq(ctx context.Context) iter.Seq2[*Schedule, error]
- func (s *Server) Schedules() ([]*Schedule, error)
- func (s *Server) SchedulesContext(ctx context.Context) ([]*Schedule, error)
- func (s *Server) SecurityInfo() (*ServerSecurityInfo, error)
- func (s *Server) SecurityInfoContext(ctx context.Context) (*ServerSecurityInfo, error)
- func (s *Server) SendMail(profile, recipients, subject, body string) error
- func (s *Server) SendMailContext(ctx context.Context, profile, recipients, subject, body string) error
- func (s *Server) ServerPermissionSeq(ctx context.Context) iter.Seq2[*ServerPermissionEntry, error]
- func (s *Server) ServerPermissions() ([]*ServerPermissionEntry, error)
- func (s *Server) ServerPermissionsContext(ctx context.Context) ([]*ServerPermissionEntry, error)
- func (s *Server) ServerRoleByName(name string) (*ServerRole, error)
- func (s *Server) ServerRoleByNameContext(ctx context.Context, name string) (*ServerRole, error)
- func (s *Server) ServerRoleMemberSeq(ctx context.Context, roleName string) iter.Seq2[*RoleMember, error]
- func (s *Server) ServerRoleMembers(roleName string) ([]*RoleMember, error)
- func (s *Server) ServerRoleMembersContext(ctx context.Context, roleName string) ([]*RoleMember, error)
- func (s *Server) ServerRoleSeq(ctx context.Context) iter.Seq2[*ServerRole, error]
- func (s *Server) ServerRoles() ([]*ServerRole, error)
- func (s *Server) ServerRolesContext(ctx context.Context) ([]*ServerRole, error)
- func (s *Server) VerifyBackup(device string) error
- func (s *Server) VerifyBackupContext(ctx context.Context, device string) error
- type ServerInfo
- type ServerMemoryStats
- type ServerPermissionEntry
- type ServerRole
- func (r *ServerRole) ChangeOwner(newOwner string) error
- func (r *ServerRole) ChangeOwnerContext(ctx context.Context, newOwner string) error
- func (r *ServerRole) Drop() error
- func (r *ServerRole) DropContext(ctx context.Context) error
- func (r *ServerRole) Rename(newName string) error
- func (r *ServerRole) RenameContext(ctx context.Context, newName string) error
- type ServerScripter
- func (sc *ServerScripter) ScriptLogin(name string) (string, error)
- func (sc *ServerScripter) ScriptLoginContext(ctx context.Context, name string) (string, error)
- func (sc *ServerScripter) ScriptServerRole(name string) (string, error)
- func (sc *ServerScripter) ScriptServerRoleContext(ctx context.Context, name string) (string, error)
- type ServerSecurityInfo
- type ServerVersion
- type SpaceInfo
- type SpatialBoundingBox
- type SpatialGridDensity
- type SpatialGridLevels
- type SpatialTessellation
- type Statistic
- func (st *Statistic) ColumnSeq(ctx context.Context) iter.Seq2[string, error]
- func (st *Statistic) Columns() ([]string, error)
- func (st *Statistic) ColumnsContext(ctx context.Context) ([]string, error)
- func (st *Statistic) DensityVector() ([]*StatisticDensity, error)
- func (st *Statistic) DensityVectorContext(ctx context.Context) ([]*StatisticDensity, error)
- func (st *Statistic) DensityVectorSeq(ctx context.Context) iter.Seq2[*StatisticDensity, error]
- func (st *Statistic) Drop() error
- func (st *Statistic) DropContext(ctx context.Context) error
- func (st *Statistic) Header() (*StatisticHeader, error)
- func (st *Statistic) HeaderContext(ctx context.Context) (*StatisticHeader, error)
- func (st *Statistic) Histogram() ([]*StatisticHistogramStep, error)
- func (st *Statistic) HistogramContext(ctx context.Context) ([]*StatisticHistogramStep, error)
- func (st *Statistic) HistogramSeq(ctx context.Context) iter.Seq2[*StatisticHistogramStep, error]
- func (st *Statistic) Rename(newName string) error
- func (st *Statistic) RenameContext(ctx context.Context, newName string) error
- func (st *Statistic) Update(samplePct int) error
- func (st *Statistic) UpdateContext(ctx context.Context, samplePct int) error
- type StatisticDensity
- type StatisticHeader
- type StatisticHistogramStep
- type StoredProcedure
- type Synonym
- type Table
- func (t *Table) AlterColumn(col ColumnDefinition) error
- func (t *Table) AlterColumnContext(ctx context.Context, col ColumnDefinition) error
- func (t *Table) CheckConstraintSeq(ctx context.Context) iter.Seq2[*CheckConstraint, error]
- func (t *Table) CheckConstraints() ([]*CheckConstraint, error)
- func (t *Table) CheckConstraintsContext(ctx context.Context) ([]*CheckConstraint, error)
- func (t *Table) CheckWhereSyntax(predicate string) error
- func (t *Table) CheckWhereSyntaxContext(ctx context.Context, predicate string) error
- func (t *Table) ColumnSeq(ctx context.Context) iter.Seq2[*Column, error]
- func (t *Table) Columns() ([]*Column, error)
- func (t *Table) ColumnsContext(ctx context.Context) ([]*Column, error)
- func (t *Table) CountWhere(predicate string) (int64, error)
- func (t *Table) CountWhereContext(ctx context.Context, predicate string) (int64, error)
- func (t *Table) CreateIndex(req CreateIndexRequest) error
- func (t *Table) CreateIndexContext(ctx context.Context, req CreateIndexRequest) error
- func (t *Table) CreateStatistic(name string, columns []string, samplePct int) error
- func (t *Table) CreateStatisticContext(ctx context.Context, name string, columns []string, samplePct int) error
- func (t *Table) CreateStatisticWithOptions(req CreateStatisticRequest) error
- func (t *Table) CreateStatisticWithOptionsContext(ctx context.Context, req CreateStatisticRequest) error
- func (t *Table) DB() *Database
- func (t *Table) DataSpace() (DataSpace, error)
- func (t *Table) DataSpaceContext(ctx context.Context) (DataSpace, error)
- func (t *Table) Detail() (*TableDetail, error)
- func (t *Table) DetailContext(ctx context.Context) (*TableDetail, error)
- func (t *Table) DropColumn(name string) error
- func (t *Table) DropColumnContext(ctx context.Context, name string) error
- func (t *Table) DropConstraint(name string) error
- func (t *Table) DropConstraintContext(ctx context.Context, name string) error
- func (t *Table) ForeignKeyByName(name string) (*ForeignKey, error)
- func (t *Table) ForeignKeyByNameContext(ctx context.Context, name string) (*ForeignKey, error)
- func (t *Table) ForeignKeySeq(ctx context.Context) iter.Seq2[*ForeignKey, error]
- func (t *Table) ForeignKeys() ([]*ForeignKey, error)
- func (t *Table) ForeignKeysContext(ctx context.Context) ([]*ForeignKey, error)
- func (t *Table) FragmentationStats(mode string) ([]*IndexFragmentation, error)
- func (t *Table) FragmentationStatsContext(ctx context.Context, mode string) ([]*IndexFragmentation, error)
- func (t *Table) FragmentationStatsSeq(ctx context.Context, mode string) iter.Seq2[*IndexFragmentation, error]
- func (t *Table) FullName() string
- func (t *Table) IndexByName(name string) (*Index, error)
- func (t *Table) IndexByNameContext(ctx context.Context, name string) (*Index, error)
- func (t *Table) IndexSeq(ctx context.Context) iter.Seq2[*Index, error]
- func (t *Table) Indexes() ([]*Index, error)
- func (t *Table) IndexesContext(ctx context.Context) ([]*Index, error)
- func (t *Table) PartitionSeq(ctx context.Context) iter.Seq2[*PartitionInfo, error]
- func (t *Table) Partitions() ([]*PartitionInfo, error)
- func (t *Table) PartitionsContext(ctx context.Context) ([]*PartitionInfo, error)
- func (t *Table) RebuildAllIndexes(fillFactor int) error
- func (t *Table) RebuildAllIndexesContext(ctx context.Context, fillFactor int) error
- func (t *Table) RenameColumn(name, newName string) error
- func (t *Table) RenameColumnContext(ctx context.Context, name, newName string) error
- func (t *Table) RowCount() (int64, error)
- func (t *Table) RowCountContext(ctx context.Context) (int64, error)
- func (t *Table) SpaceUsed() (*TableSpaceInfo, error)
- func (t *Table) SpaceUsedContext(ctx context.Context) (*TableSpaceInfo, error)
- func (t *Table) StatisticByName(name string) (*Statistic, error)
- func (t *Table) StatisticByNameContext(ctx context.Context, name string) (*Statistic, error)
- func (t *Table) StatisticSeq(ctx context.Context) iter.Seq2[*Statistic, error]
- func (t *Table) Statistics() ([]*Statistic, error)
- func (t *Table) StatisticsContext(ctx context.Context) ([]*Statistic, error)
- func (t *Table) TriggerSeq(ctx context.Context) iter.Seq2[*Trigger, error]
- func (t *Table) Triggers() ([]*Trigger, error)
- func (t *Table) TriggersContext(ctx context.Context) ([]*Trigger, error)
- func (t *Table) TruncateTable() error
- func (t *Table) TruncateTableContext(ctx context.Context) error
- func (t *Table) UpdateAllStatistics(samplePct int) error
- func (t *Table) UpdateAllStatisticsContext(ctx context.Context, samplePct int) error
- func (t *Table) XMLIndexSeq(ctx context.Context) iter.Seq2[*XMLIndex, error]
- func (t *Table) XMLIndexes() ([]*XMLIndex, error)
- func (t *Table) XMLIndexesContext(ctx context.Context) ([]*XMLIndex, error)
- type TableChangeTracking
- type TableDetail
- type TableSpaceInfo
- type TextCriterion
- type TextOp
- type Trigger
- type User
- func (u *User) AddToRole(roleName string) error
- func (u *User) AddToRoleContext(ctx context.Context, roleName string) error
- func (u *User) Deny(permission ObjectPermission, objectSchema, objectName string) error
- func (u *User) DenyContext(ctx context.Context, permission ObjectPermission, ...) error
- func (u *User) Drop() error
- func (u *User) DropContext(ctx context.Context) error
- func (u *User) Grant(permission ObjectPermission, objectSchema, objectName string) error
- func (u *User) GrantContext(ctx context.Context, permission ObjectPermission, ...) error
- func (u *User) RemoveFromRole(roleName string) error
- func (u *User) RemoveFromRoleContext(ctx context.Context, roleName string) error
- func (u *User) Rename(newName string) error
- func (u *User) RenameContext(ctx context.Context, newName string) error
- func (u *User) Revoke(permission ObjectPermission, objectSchema, objectName string) error
- func (u *User) RevokeContext(ctx context.Context, permission ObjectPermission, ...) error
- func (u *User) SetDefaultSchema(schemaName string) error
- func (u *User) SetDefaultSchemaContext(ctx context.Context, schemaName string) error
- func (u *User) SetLogin(loginName string) error
- func (u *User) SetLoginContext(ctx context.Context, loginName string) error
- type UserDefinedFunction
- type View
- type XMLIndex
- type XMLSecondaryIndexType
Constants ¶
const ( WeekdaySunday = 1 WeekdayMonday = 2 WeekdayTuesday = 4 WeekdayWednesday = 8 WeekdayThursday = 16 WeekdayFriday = 32 WeekdaySaturday = 64 )
Weekday bitmask values for a FreqWeekly schedule's FreqInterval.
const ( RelativeDaySunday = 1 RelativeDayMonday = 2 RelativeDayTuesday = 3 RelativeDayWednesday = 4 RelativeDayThursday = 5 RelativeDayFriday = 6 RelativeDaySaturday = 7 RelativeDayDay = 8 RelativeDayWeekday = 9 RelativeDayWeekendDay = 10 )
Single-value day codes for a FreqMonthlyRelative schedule's FreqInterval. Unlike FreqWeekly's bitmask above, these are sequential (1=Sunday through 7=Saturday), not powers of two, plus three special values.
const ( RelativeFirst = 1 RelativeSecond = 2 RelativeThird = 4 RelativeFourth = 8 RelativeLast = 16 )
FreqRelativeInterval values for a FreqMonthlyRelative schedule.
Variables ¶
var ErrNotFound = errors.New("not found")
ErrNotFound is the sentinel every by-name lookup that reports absence as an error wraps, so a caller can tell "this object does not exist" from "the lookup itself failed" with errors.Is(err, gosmo.ErrNotFound) instead of matching on message text.
Making that distinction matters: a caller that treats any error as absence will go on to create an object it never established was missing, and report the creation's failure instead of the permission or connection error that actually stopped it.
Three not-found conventions exist across the package, and the difference is deliberate rather than an oversight:
- Most by-name lookups — LoginByName, DatabaseByName, TableByName, UserByName, RoleByName, AgentJobByName, AlertByName, OperatorByName, ScheduleByName, ServerRoleByName, ConfigurationByName, AvailabilityGroupByName and the scripter's view/procedure/function lookups — return an error wrapping ErrNotFound.
- CertificateByName returns (nil, nil), because its callers branch on absence as the ordinary case rather than the exceptional one.
- AgentStatus reports an unreachable Agent as a populated value (StatusText "Unknown"), not an error.
AvailabilityGroupByName's not-found error additionally still satisfies errors.Is(err, sql.ErrNoRows), which it promised before ErrNotFound existed.
var ProbedDatabasePermissions = []string{
"CONTROL",
"ALTER",
"VIEW DEFINITION",
"VIEW DATABASE STATE",
"BACKUP DATABASE",
"BACKUP LOG",
"CREATE TABLE",
"CREATE VIEW",
"CREATE PROCEDURE",
"CREATE FUNCTION",
"CREATE SCHEMA",
"ALTER ANY USER",
"ALTER ANY ROLE",
"ALTER ANY SCHEMA",
"ALTER ANY DATASPACE",
"SELECT",
"INSERT",
"UPDATE",
"DELETE",
"EXECUTE",
"SHOWPLAN",
}
ProbedDatabasePermissions are the database-scope permissions DatabaseCapabilities probes — again a working subset, not the grantable catalog DatabasePermissionNames returns.
These are checked against the DATABASE securable class, not the server: HAS_PERMS_BY_NAME(NULL, NULL, 'ALTER') asks about the *server* and answers NULL, which is how a database-scope name mistakenly probed at server scope disappears without an error.
var ProbedDatabaseRoles = []string{
"db_owner",
"db_securityadmin",
"db_accessadmin",
"db_backupoperator",
"db_ddladmin",
"db_datawriter",
"db_datareader",
"db_denydatawriter",
"db_denydatareader",
"SQLAgentUserRole",
"SQLAgentReaderRole",
"SQLAgentOperatorRole",
}
ProbedDatabaseRoles are the fixed database roles DatabaseCapabilities probes.
The three SQLAgent* roles exist only in msdb; elsewhere IS_ROLEMEMBER returns NULL for them and they read as false. They are probed for every database rather than only msdb because doing so costs nothing and keeps one code path.
var ProbedServerPermissions = []string{
"CONTROL SERVER",
"ALTER SETTINGS",
"SHUTDOWN",
"ALTER TRACE",
"ADMINISTER BULK OPERATIONS",
"VIEW ANY DATABASE",
"VIEW ANY DEFINITION",
"VIEW SERVER STATE",
"VIEW SERVER PERFORMANCE STATE",
"VIEW SERVER SECURITY STATE",
"CREATE ANY DATABASE",
"ALTER ANY DATABASE",
"ALTER ANY LOGIN",
"ALTER ANY SERVER ROLE",
"ALTER ANY CONNECTION",
"ALTER ANY CREDENTIAL",
"ALTER ANY ENDPOINT",
"ALTER ANY LINKED SERVER",
"ALTER ANY EVENT SESSION",
"ALTER ANY AVAILABILITY GROUP",
}
ProbedServerPermissions are the server-scope permissions Capabilities probes: the handful the application layer gates on, not the whole grantable catalog ServerPermissionNames returns. Every name here was checked against a live instance; a name with a typo would report CapabilityUnknown forever rather than failing.
VIEW SERVER PERFORMANCE STATE and VIEW SERVER SECURITY STATE are the two narrower rights SQL Server 2022 split VIEW SERVER STATE into, and are what a modern instance names in its denial. All three are probed because holding the wide one grants both narrow ones, but not the reverse.
var ProbedServerRoles = []string{
"sysadmin",
"serveradmin",
"securityadmin",
"processadmin",
"setupadmin",
"bulkadmin",
"diskadmin",
"dbcreator",
"public",
}
ProbedServerRoles are the fixed server roles Capabilities probes.
Membership in sysadmin does not imply membership in any other role, so a caller testing for a role must test for sysadmin too — see Capabilities.InServerRole.
Functions ¶
func BuildBackupStatement ¶ added in v0.0.4
func BuildBackupStatement(opts BackupOptions) (string, error)
BuildBackupStatement returns the T-SQL BACKUP statement opts describes, without executing it — for callers that want to show or hand off the script (e.g. an editor pane) rather than run it immediately. BackupContext validates and builds the statement the same way, then runs what this returns.
func BuildRestoreStatement ¶ added in v0.0.5
func BuildRestoreStatement(opts RestoreOptions) (string, error)
BuildRestoreStatement returns the T-SQL RESTORE statement opts describes, without executing it — the RESTORE counterpart of BuildBackupStatement. RestoreContext validates and builds the statement the same way, then runs what this returns.
The statement is laid out over several lines — the target, the devices, then one WITH option per line — because a restore that relocates files carries a MOVE clause per database file, each holding two full paths. On one line that runs to several hundred columns, and a caller scripting it for review (goSSMS's Restore dialog does) sees the RESTORE with every MOVE off the right edge of the editor, which reads as the MOVE clauses being missing entirely. Whitespace is not significant to SQL Server here, so the executed statement is unchanged.
func ColumnPermissionNames ¶ added in v0.0.8
func ColumnPermissionNames() []string
ColumnPermissionNames returns every permission name GRANT/DENY/REVOKE accepts on a column, sorted — the catalog a column-permissions grid enumerates, the way ObjectPermissionNames is the catalog for the whole object.
func ColumnTypeString ¶ added in v0.0.5
ColumnTypeString returns the T-SQL data-type fragment for a Column read from sys.columns.
func DatabasePermissionNames ¶ added in v0.0.5
func DatabasePermissionNames() []string
DatabasePermissionNames returns every database-scoped permission name GRANT/DENY/REVOKE accepts, sorted — see ServerPermissionNames for what it's used for.
func IsRetryable ¶ added in v0.0.4
IsRetryable reports whether err represents a transient failure worth retrying — the driver's RetryableError; a dropped pooled connection (driver.ErrBadConn), including when wrapped; or one of the raw connection-level failures the driver itself uses to flag a connection dead (see mssql.Conn.checkBadConn): a network error, a corrupted TDS byte stream (mssql.StreamError), a fatal server-side error that severs the connection (mssql.ServerError), or io.EOF. Those last few surface unwrapped rather than as RetryableError whenever the driver decided retrying the exact in-flight call wasn't safe (its own mayRetry=false) — that restriction is about automatically retrying the *same* call, not about whether the connection itself is salvageable, so a caller retrying its own idempotent operation on a fresh connection is still safe to do so. It is exported so callers that run their own statements (e.g. an ad-hoc query runner) can decide whether a failure is worth another attempt; note that only idempotent operations are safe to retry blindly.
A context error is never retryable. context.DeadlineExceeded has to be rejected explicitly because it implements net.Error, so the net.Error test below would otherwise report a caller's own expired deadline as a transient failure and have them wait out three attempts on a deadline that has already passed. context.Canceled fails that test anyway and is named alongside it so the two can't drift apart.
func ObjectPermissionNames ¶ added in v0.0.5
func ObjectPermissionNames() []string
ObjectPermissionNames returns every object-scoped permission name GRANT/DENY/REVOKE accepts on a table or view, sorted — see ServerPermissionNames for what it's used for.
func ParseServerAddress ¶ added in v0.0.4
ParseServerAddress splits a user-supplied server address into its host, named-instance, and port components, accepting every form SSMS itself accepts in its "Server name" field:
host host:port host,port host\instance host\instance,port
Exported so callers (e.g. a UI layer building its own address/DSN preview, or resolving a separate "port" field against a Server string that may already carry its own) can reuse the same parsing buildDSN relies on, instead of duplicating it.
A malformed trailing port (non-numeric) is left as part of host rather than rejected outright — the caller surfaces connection failures via the driver's own error, not a separate parse error here.
func QuoteLiteral ¶ added in v0.0.4
QuoteLiteral renders s as a T-SQL string literal, including the surrounding single quotes and doubling any embedded quote — safe to embed in SQL text where a parameter placeholder is not accepted (DDL, dynamic SQL). Prefer a query parameter for ordinary values.
Use QuoteLiteral where the whole literal is being produced. Where the quotes are already part of a format string — the common shape in this package, e.g. "@name = N'%s'" — use the unexported escapeSingle (helpers.go) instead, which escapes without adding quotes of its own. QuoteLiteral also does not emit the N prefix.
Neither one quotes an *identifier*. An identifier that ends up inside a string literal — the argument to OBJECT_ID, DBCC SHOW_STATISTICS, fn_listextendedproperty, and similar — needs QuoteName/qualifiedName applied first and escapeSingle on top of that:
escapeSingle(qualifiedName(schema, name)) // -> [dbo].[Sales.Archive] escapeSingle(t.FullName()) // same, for a *Table
Skipping the bracket-quoting is not cosmetic. A name containing '.' then parses as a multi-part name and resolves to the wrong object or to NULL, and a NULL object_id means "every object in the database" to sys.dm_db_index_physical_stats — so the wrong form returns plausible stats for the wrong tables instead of failing. See identifier_quoting_test.go, which pins all of this.
func QuoteName ¶ added in v0.0.4
QuoteName wraps a SQL Server identifier (schema, table, column, ...) in square brackets, doubling any embedded closing bracket — the equivalent of T-SQL's QUOTENAME(). Use it to build object names safely; note it quotes the whole string as one identifier, so pass each part of a multi-part name separately.
func SchemaPermissionNames ¶ added in v0.0.5
func SchemaPermissionNames() []string
SchemaPermissionNames returns every schema-scoped permission name GRANT/DENY/REVOKE accepts ON SCHEMA::x, sorted — see ObjectPermissionNames for what it's used for.
func Scripting ¶ added in v0.0.7
Scripting reports whether ctx came from WithScript — that is, whether write methods invoked with it record their statement instead of running it.
A caller that mirrors a write into its own state needs to know: under WithScript a write returns success without the server ever seeing it, so state derived from "it worked" is wrong. The case this exists for is a rename — an editor that renames an object and then re-reads it by the new name finds nothing, because the old name is still what the server has. Reads are unaffected by WithScript and go to the real server either way.
func ServerPermissionNames ¶ added in v0.0.5
func ServerPermissionNames() []string
ServerPermissionNames returns every server-scoped permission name GRANT/DENY/REVOKE accepts, sorted — the catalog SSMS's Server Properties > Permissions page enumerates for a principal regardless of whether it already has an explicit GRANT/DENY entry.
Types ¶
type ActiveSession ¶
type ActiveSession struct {
SessionID int
LoginName string
HostName string
ProgramName string
DatabaseName string
Status string
CPUTime int64
MemoryUsage int64
TotalElapsedMS int64
LastRequestStart string
CommandText string
BlockingSessionID int
WaitType string
WaitTimeMS int64
}
ActiveSession holds information about one session from sys.dm_exec_sessions.
type AgentStatus ¶ added in v0.0.6
type AgentStatus struct {
Running bool
StatusText string
// LastStartupTime is the zero Time if the DMV has no matching row (the
// Agent service isn't registered under this instance, or the DMV isn't
// queryable in this edition/deployment).
LastStartupTime time.Time
}
AgentStatus reports whether SQL Server Agent is currently running, based only on SQL-visible state (sys.dm_server_services) — no Windows Service Control, WMI, or registry access, matching the SQL-only scope of the rest of this file.
type Alert ¶ added in v0.0.6
type Alert struct {
ID int
Name string
Enabled bool
// EventSource is "MSSQLSERVER" for a plain SQL Server event alert, or
// "WMI" for a WMI alert — see IsEventAlert.
EventSource string
// ErrorNumber is sysalerts.message_id — mutually exclusive in practice
// with Severity (SQL Server Agent triggers on whichever is nonzero).
ErrorNumber int
Severity int
DatabaseName string
DelayBetweenResponses time.Duration
NotificationMessage string
// IncludeEventDescriptionIn is sysalerts.include_event_description —
// msdb's own bitmask for which notification channel(s) get the event
// description text appended (0=None, 1=Email, 2=Pager, 4=NetSend,
// 7=All). Named "...In" after sp_add_alert/sp_update_alert's
// @include_event_description_in parameter; the column itself has no
// "_in" suffix, the two names genuinely diverge.
IncludeEventDescriptionIn int
EventDescriptionKeyword string
Category string
// JobName is the job executed in response to this alert, or "" if none.
JobName string
PerformanceCondition string
OccurrenceCount int
LastOccurrence time.Time
LastResponse time.Time
// contains filtered or unexported fields
}
Alert represents a SQL Server Agent alert (msdb.dbo.sysalerts).
func (*Alert) DisableContext ¶ added in v0.0.6
DisableContext is the context-aware variant of Disable.
func (*Alert) DropContext ¶ added in v0.0.6
DropContext is the context-aware variant of Drop.
func (*Alert) EnableContext ¶ added in v0.0.6
EnableContext is the context-aware variant of Enable.
func (*Alert) IsEventAlert ¶ added in v0.0.6
IsEventAlert reports whether this is a plain SQL Server event alert (an error-number-or-severity trigger) rather than a WMI alert or a performance-condition alert — the SQL-only-implementable subset of SQL Server Agent alerts (no WMI provider, no performance counter access). See Server.EventAlerts. Only EventSource and PerformanceCondition are checked — sysalerts.wmi_query/wmi_namespace, WMI's own supplementary columns, don't exist on every build (they're absent on SQL Server on Linux, where WMI doesn't apply at all), so gosmo doesn't select them; event_source = 'WMI' is the reliable, always-present discriminator SQL Server itself sets for a WMI alert.
func (*Alert) NotificationSeq ¶ added in v0.0.6
NotificationSeq returns an iterator over every operator notified by this alert.
func (*Alert) Notifications ¶ added in v0.0.6
func (a *Alert) Notifications() ([]*AlertNotification, error)
Notifications returns every operator notified by this alert.
func (*Alert) NotificationsContext ¶ added in v0.0.6
func (a *Alert) NotificationsContext(ctx context.Context) ([]*AlertNotification, error)
NotificationsContext is the context-aware variant of Notifications.
func (*Alert) Notify ¶ added in v0.0.6
func (a *Alert) Notify(operatorName string, method NotificationMethod) error
Notify configures the alert to notify an operator via sp_add_notification.
func (*Alert) NotifyContext ¶ added in v0.0.6
func (a *Alert) NotifyContext(ctx context.Context, operatorName string, method NotificationMethod) error
NotifyContext is the context-aware variant of Notify.
func (*Alert) RemoveNotify ¶ added in v0.0.6
RemoveNotify removes an operator's notification link from the alert.
func (*Alert) RemoveNotifyContext ¶ added in v0.0.6
RemoveNotifyContext is the context-aware variant of RemoveNotify.
func (*Alert) RenameContext ¶ added in v0.0.6
RenameContext is the context-aware variant of Rename.
func (*Alert) SetCategory ¶ added in v0.0.6
SetCategory reassigns the alert's category. category == "" clears it — sent as the real [Uncategorized] category, since sp_update_alert rejects an empty name outright ("The specified @category_name (”) does not exist") and [Uncategorized] is what an alert created with no category actually holds in msdb.dbo.syscategories.
func (*Alert) SetCategoryContext ¶ added in v0.0.6
SetCategoryContext is the context-aware variant of SetCategory.
func (*Alert) SetDatabase ¶ added in v0.0.6
SetDatabase scopes the alert to a single database, or "" for all databases.
func (*Alert) SetDatabaseContext ¶ added in v0.0.6
SetDatabaseContext is the context-aware variant of SetDatabase.
func (*Alert) SetDelay ¶ added in v0.0.6
SetDelay sets the minimum delay between repeated responses to the alert.
func (*Alert) SetDelayContext ¶ added in v0.0.6
SetDelayContext is the context-aware variant of SetDelay.
func (*Alert) SetJobResponse ¶ added in v0.0.6
SetJobResponse sets the job executed in response to this alert, or "" to clear it.
func (*Alert) SetJobResponseContext ¶ added in v0.0.6
SetJobResponseContext is the context-aware variant of SetJobResponse.
func (*Alert) SetNotificationMessage ¶ added in v0.0.6
SetNotificationMessage sets the extra text appended to the alert's notification.
func (*Alert) SetNotificationMessageContext ¶ added in v0.0.6
SetNotificationMessageContext is the context-aware variant of SetNotificationMessage.
func (*Alert) SetTrigger ¶ added in v0.0.6
SetTrigger sets what raises the alert: a specific SQL Server error number, or a severity level. SQL Server treats these as mutually exclusive — pass 0 for whichever one isn't in use.
type AlertNotification ¶ added in v0.0.6
type AlertNotification struct {
OperatorName string
Method NotificationMethod
}
AlertNotification describes one operator notified by an alert.
type AlertNotificationRef ¶ added in v0.0.6
type AlertNotificationRef struct {
AlertName string
Method NotificationMethod
}
AlertNotificationRef describes one alert configured to notify an operator.
type AuthMethod ¶
type AuthMethod int
AuthMethod selects the authentication strategy for Connect().
const ( // AuthSQLServer uses a SQL Server login and password. // Set ConnectionOptions.User and ConnectionOptions.Password. AuthSQLServer AuthMethod = iota // AuthWindows uses the Windows/Active Directory identity (on-premises, // domain-joined host). On Windows it uses native SSPI. On every other // platform it authenticates via Kerberos: with no credentials it uses the // ambient kinit credential cache (single sign-on); set ConnectionOptions. // Kerberos for a keytab, an explicit realm, or a non-default krb5.conf, // or set User+Password for a username/password Kerberos login. AuthWindows // AuthEntraDefault uses DefaultAzureCredential (env vars -> MSI -> AzCLI). // Ideal for code that must work both locally and in Azure without changes. AuthEntraDefault // AuthEntraPassword uses an Entra user UPN + password. // Set ConnectionOptions.User (UPN) and ConnectionOptions.Password. AuthEntraPassword // AuthEntraMSI uses a system-assigned Managed Identity. // Set ConnectionOptions.ClientID to select a user-assigned identity. AuthEntraMSI // AuthEntraServicePrincipal uses an app registration client-secret or cert. // Set ConnectionOptions.User to the application (client) ID, // ConnectionOptions.TenantID, and either: // - ConnectionOptions.Password (client secret), or // - ConnectionOptions.ClientCertPath + optionally ClientCertPassword (cert). AuthEntraServicePrincipal // AuthEntraServicePrincipalAccessToken presents a pre-acquired bearer token. // Set ConnectionOptions.AccessToken. AuthEntraServicePrincipalAccessToken // AuthEntraIntegrated uses Windows SSO federated with Entra (on-premises AD // joined to Azure AD). No credentials needed. AuthEntraIntegrated // AuthEntraInteractive opens a browser for interactive sign-in (human only). // Set ConnectionOptions.ApplicationClientID if required by the tenant. AuthEntraInteractive // AuthEntraDeviceCode prints a device code for human sign-in on another device. AuthEntraDeviceCode // AuthEntraAzCLI uses the credential from "az login". AuthEntraAzCLI // AuthEntraAzureDeveloperCLI uses the credential from "azd auth login". AuthEntraAzureDeveloperCLI // AuthEntraAzurePipelines uses Azure DevOps OIDC federated credentials. // Requires SYSTEM_ACCESSTOKEN and SYSTEM_OIDCREQUESTURI env vars. AuthEntraAzurePipelines // AuthEntraOnBehalfOf uses the OAuth 2.0 on-behalf-of flow. // Set ConnectionOptions.AccessToken to the inbound user assertion. AuthEntraOnBehalfOf )
type AvailabilityDatabase ¶ added in v0.0.9
type AvailabilityDatabase struct {
GroupID string
ReplicaID string
ReplicaServerName string
DatabaseName string
GroupDatabaseID string
IsLocal bool
IsPrimaryReplica bool
SynchronizationState string
SynchronizationHealth string
DatabaseState string
IsSuspended bool
SuspendReason string
LogSendQueueKB int64
LogSendRateKBps int64
RedoQueueKB int64
RedoRateKBps int64
// SecondaryLagSeconds is how far this secondary trails the primary.
// SQL Server 2016+; 0 on older versions and on the primary itself.
SecondaryLagSeconds int64
LastSentTime time.Time
LastReceivedTime time.Time
LastHardenedTime time.Time
LastRedoneTime time.Time
LastCommitTime time.Time
}
AvailabilityDatabase is one database's synchronization state on one replica. A group with two databases and three replicas yields six rows, of which the local instance can normally only populate the queue/rate/LSN detail for its own.
The queue and rate figures are in kilobytes and kilobytes per second, as SQL Server reports them; they are left at zero for a replica whose state this instance cannot see.
type AvailabilityGroup ¶ added in v0.0.9
type AvailabilityGroup struct {
ID string
Name string
ResourceID string
ResourceGroupID string
// ClusterType is WSFC, EXTERNAL or NONE. It is empty before SQL Server
// 2017, which had no cluster_type column and only ever meant WSFC.
// Upper-cased by agColumns, which is what makes those spellings true —
// SQL Server reports this one in lower case.
//
// This is the field that decides whether a failover can be performed
// through T-SQL at all: under EXTERNAL the cluster manager owns failover
// and SQL Server rejects both ALTER AVAILABILITY GROUP ... FAILOVER and
// ... FORCE_FAILOVER_ALLOW_DATA_LOSS with error 47104.
ClusterType string
AutomatedBackupPreference string
FailureConditionLevel int
HealthCheckTimeout int
Version int
// BasicFeatures reports a Basic availability group (Standard edition):
// one database, two replicas, no readable secondary. SQL Server 2016+.
BasicFeatures bool
DTCSupport bool
DBFailover bool
IsDistributed bool
// RequiredSynchronizedSecondariesToCommit is SQL Server 2017+; it is 0 on
// older versions, which is also a legitimate value, so it cannot be used
// to detect support.
RequiredSynchronizedSecondariesToCommit int
// IsContained reports a contained availability group, which carries its
// own master and msdb. SQL Server 2022+.
IsContained bool
PrimaryReplicaServerName string
PrimaryRecoveryHealth string
SynchronizationHealth string
// contains filtered or unexported fields
}
AvailabilityGroup represents one Always On availability group, as seen from the instance the owning Server is connected to.
The fields sourced from sys.dm_hadr_availability_group_states (PrimaryReplicaServerName, PrimaryRecoveryHealth, SynchronizationHealth) are empty when the local instance has no state row for the group — which happens while the group is resolving, or on an instance that has joined but not yet connected. An empty PrimaryReplicaServerName means "unknown from here", not "no primary exists".
func (*AvailabilityGroup) AddDatabase ¶ added in v0.0.9
func (ag *AvailabilityGroup) AddDatabase(name string) error
AddDatabase adds a database on the primary to the availability group.
Run against the primary. The database must already be in the full recovery model with a log backup taken; SQL Server rejects it otherwise. What happens on the secondaries afterwards depends on their seeding mode: an AUTOMATIC replica seeds itself, a MANUAL one needs the database restored there and then JoinDatabase called against it.
func (*AvailabilityGroup) AddDatabaseContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) AddDatabaseContext(ctx context.Context, name string) error
AddDatabaseContext is the context-aware variant of AddDatabase.
func (*AvailabilityGroup) AddListener ¶ added in v0.0.9
func (ag *AvailabilityGroup) AddListener(spec AvailabilityListenerSpec) error
AddListener creates the group's listener. Run against the primary.
Under an EXTERNAL cluster type this records the listener in SQL Server's own metadata only — the address itself belongs to the external cluster manager (on Linux, a Pacemaker IPaddr2 resource), which has to be configured separately for clients to actually reach it. Unlike failover, the statement itself is accepted.
func (*AvailabilityGroup) AddListenerContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) AddListenerContext(ctx context.Context, spec AvailabilityListenerSpec) error
AddListenerContext is the context-aware variant of AddListener.
func (*AvailabilityGroup) AddListenerIP ¶ added in v0.0.9
func (ag *AvailabilityGroup) AddListenerIP(dnsName string, ip AvailabilityListenerIPSpec) error
AddListenerIP binds another static address to an existing listener — the second and later subnets of a multi-subnet listener. Run against the primary.
A listener created WITH DHCP cannot be given static addresses this way; SQL Server rejects the statement.
There is no matching REMOVE IP: an address bound here stays for the life of the listener, and correcting one means REMOVE LISTENER and ADD LISTENER.
Under an EXTERNAL cluster type the address is recorded but not brought up — it appears in sys.availability_group_listener_ip_addresses as OFFLINE, because the external cluster manager owns the address, not SQL Server. Verified on SQL Server 2025 under Pacemaker.
func (*AvailabilityGroup) AddListenerIPContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) AddListenerIPContext(ctx context.Context, dnsName string, ip AvailabilityListenerIPSpec) error
AddListenerIPContext is the context-aware variant of AddListenerIP.
func (*AvailabilityGroup) AddReplica ¶ added in v0.0.9
func (ag *AvailabilityGroup) AddReplica(spec AvailabilityReplicaSpec) error
AddReplica adds a secondary replica to an existing availability group.
This is the first of three statements, and on its own it leaves the new replica disconnected — exactly as CreateAvailabilityGroup does for the replicas it names. Run this against the primary, then, connected to the new replica itself:
- Join, which is the only way the replica actually enters the group; and
- GrantCreateAnyDatabase, if the spec seeds AUTOMATIC, without which seeding silently copies nothing.
The replica must already have a started database mirroring endpoint that the other replicas can reach, and its FailoverMode has to match what the group's cluster type permits — EXTERNAL requires EXTERNAL, NONE requires MANUAL.
func (*AvailabilityGroup) AddReplicaContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) AddReplicaContext(ctx context.Context, spec AvailabilityReplicaSpec) error
AddReplicaContext is the context-aware variant of AddReplica.
func (*AvailabilityGroup) DatabaseSeq ¶ added in v0.0.9
func (ag *AvailabilityGroup) DatabaseSeq(ctx context.Context) iter.Seq2[*AvailabilityDatabase, error]
DatabaseSeq returns an iterator over the per-replica synchronization state of every database in the availability group.
func (*AvailabilityGroup) Databases ¶ added in v0.0.9
func (ag *AvailabilityGroup) Databases() ([]*AvailabilityDatabase, error)
Databases returns the per-replica synchronization state of every database in the group.
The database list comes from sys.availability_databases_cluster, which is cluster-wide metadata, so a database appears even on a replica that has not finished seeding it — with empty state rather than being silently missing.
func (*AvailabilityGroup) DatabasesContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) DatabasesContext(ctx context.Context) ([]*AvailabilityDatabase, error)
DatabasesContext is the context-aware variant of Databases.
func (*AvailabilityGroup) DenyCreateAnyDatabase ¶ added in v0.0.9
func (ag *AvailabilityGroup) DenyCreateAnyDatabase() error
DenyCreateAnyDatabase revokes what GrantCreateAnyDatabase granted.
func (*AvailabilityGroup) DenyCreateAnyDatabaseContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) DenyCreateAnyDatabaseContext(ctx context.Context) error
DenyCreateAnyDatabaseContext is the context-aware variant of DenyCreateAnyDatabase.
func (*AvailabilityGroup) Drop ¶ added in v0.0.9
func (ag *AvailabilityGroup) Drop() error
Drop deletes the availability group.
Run against the primary, which drops the group cluster-wide. Running it on a secondary instead removes only that replica's participation and leaves the group running elsewhere — SQL Server does not warn about the difference, so check IsLocalPrimary first if the intent is to delete the group.
The databases survive: the primary's copies stay online and read-write, and each secondary is left with the same unusable copies RemoveDatabase leaves behind.
func (*AvailabilityGroup) DropContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
func (*AvailabilityGroup) Failover ¶ added in v0.0.9
func (ag *AvailabilityGroup) Failover() error
Failover makes this replica the primary, without data loss.
Run against the secondary that should become primary — not against the current primary. The target must be a synchronous-commit replica in the SYNCHRONIZED state; SQL Server refuses otherwise rather than failing over with loss.
Whether this works at all is decided by ClusterType, and only WSFC allows it. Under EXTERNAL it is rejected with error 47104 ("Use the cluster management tools to perform the operation"), because the external cluster manager owns failover — Pacemaker's `crm resource move`, not SQL Server. Under NONE it is rejected with error 47122, which says only forced failover is supported. Both verified against SQL Server 2025. Check ClusterType before offering this; the statement is sent and refused, not silently ignored.
func (*AvailabilityGroup) FailoverContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) FailoverContext(ctx context.Context) error
FailoverContext is the context-aware variant of Failover.
func (*AvailabilityGroup) ForceFailoverAllowDataLoss ¶ added in v0.0.9
func (ag *AvailabilityGroup) ForceFailoverAllowDataLoss() error
ForceFailoverAllowDataLoss makes this replica the primary even though it may not hold every committed transaction.
Run against the secondary that should become primary. This is the disaster path: any transaction the target had not hardened is lost, and every other secondary has to be resumed (and may need reseeding) afterwards. Prefer Failover wherever the target is SYNCHRONIZED.
Rejected with error 47104 under an EXTERNAL cluster type, exactly as Failover is. Under NONE it is the *only* failover there is, which is why a read-scale group has no lossless one.
func (*AvailabilityGroup) ForceFailoverAllowDataLossContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) ForceFailoverAllowDataLossContext(ctx context.Context) error
ForceFailoverAllowDataLossContext is the context-aware variant of ForceFailoverAllowDataLoss.
func (*AvailabilityGroup) GrantCreateAnyDatabase ¶ added in v0.0.9
func (ag *AvailabilityGroup) GrantCreateAnyDatabase() error
GrantCreateAnyDatabase lets the availability group create databases on this instance, which is what automatic seeding needs to materialise a secondary copy.
Run against each secondary. Without it a replica set to SEEDING_MODE = AUTOMATIC seeds nothing, and reports no error for it — the database simply never appears.
func (*AvailabilityGroup) GrantCreateAnyDatabaseContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) GrantCreateAnyDatabaseContext(ctx context.Context) error
GrantCreateAnyDatabaseContext is the context-aware variant of GrantCreateAnyDatabase.
func (*AvailabilityGroup) IsLocalPrimary ¶ added in v0.0.9
func (ag *AvailabilityGroup) IsLocalPrimary() bool
IsLocalPrimary reports whether the instance this group was read from is currently the group's primary replica. False when the primary is elsewhere *or* unknown from here, so it is safe to branch on but not to invert: !IsLocalPrimary() does not prove a remote primary exists.
func (*AvailabilityGroup) Join ¶ added in v0.0.9
func (ag *AvailabilityGroup) Join(clusterType string) error
Join joins the instance this group was read from to it, as a secondary.
Run against the secondary — the primary cannot join anything on its behalf. The group must already name this instance as a replica, which CreateAvailabilityGroup's REPLICA ON list does.
**Under CLUSTER_TYPE = EXTERNAL or NONE the group does not exist on the secondary until this succeeds.** Only a WSFC cluster propagates the metadata ahead of the join, so AvailabilityGroupByName on the secondary comes back "no rows" and there is nothing to call this on — use Server.AvailabilityGroup to build a handle by name instead. Verified against SQL Server 2025.
clusterType is passed rather than read off the group for the same reason: a handle that had to be built by name has no metadata to read. It must match what the group was created with, and EXTERNAL and NONE are rejected when it does not; pass "" or "WSFC" for a Windows cluster, which takes no clause.
func (*AvailabilityGroup) JoinContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) JoinContext(ctx context.Context, clusterType string) error
JoinContext is the context-aware variant of Join.
func (*AvailabilityGroup) JoinDatabase ¶ added in v0.0.9
func (ag *AvailabilityGroup) JoinDatabase(name string) error
JoinDatabase joins a restored secondary copy of a database to the group.
Run against the secondary holding the copy, after restoring it WITH NORECOVERY from a full and a log backup of the primary's. Only needed for a MANUAL-seeding replica; an AUTOMATIC one joins itself as part of seeding.
func (*AvailabilityGroup) JoinDatabaseContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) JoinDatabaseContext(ctx context.Context, name string) error
JoinDatabaseContext is the context-aware variant of JoinDatabase.
func (*AvailabilityGroup) ListenerSeq ¶ added in v0.0.9
func (ag *AvailabilityGroup) ListenerSeq(ctx context.Context) iter.Seq2[*AvailabilityGroupListener, error]
ListenerSeq returns an iterator over the availability group's listeners.
func (*AvailabilityGroup) Listeners ¶ added in v0.0.9
func (ag *AvailabilityGroup) Listeners() ([]*AvailabilityGroupListener, error)
Listeners returns the group's listeners, each with its IP addresses.
func (*AvailabilityGroup) ListenersContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) ListenersContext(ctx context.Context) ([]*AvailabilityGroupListener, error)
ListenersContext is the context-aware variant of Listeners.
func (*AvailabilityGroup) RemoveDatabase ¶ added in v0.0.9
func (ag *AvailabilityGroup) RemoveDatabase(name string) error
RemoveDatabase removes a database from the availability group.
Run against the primary, which removes the database from the group cluster-wide. The primary's copy stays online and read-write; each secondary is left holding a copy that is no longer in any role, so every connection to it fails with error 983 until it is dropped or restored WITH RECOVERY. sys.databases still reports that copy as ONLINE, so state_desc is not the way to find one — verified against SQL Server 2025.
func (*AvailabilityGroup) RemoveDatabaseContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) RemoveDatabaseContext(ctx context.Context, name string) error
RemoveDatabaseContext is the context-aware variant of RemoveDatabase.
func (*AvailabilityGroup) RemoveListener ¶ added in v0.0.9
func (ag *AvailabilityGroup) RemoveListener(dnsName string) error
RemoveListener drops the group's listener by DNS name. Run against the primary. Existing connections made through the listener are not dropped.
func (*AvailabilityGroup) RemoveListenerContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) RemoveListenerContext(ctx context.Context, dnsName string) error
RemoveListenerContext is the context-aware variant of RemoveListener.
func (*AvailabilityGroup) RemoveReplica ¶ added in v0.0.9
func (ag *AvailabilityGroup) RemoveReplica(serverName string) error
RemoveReplica removes a secondary replica from the group.
Run against the primary; a secondary cannot remove itself, and rejects the attempt with error 41190.
The removed instance is not cleaned up by this: it keeps both its copies of the databases and a stale row for the group in its own sys.availability_groups, which only DROP AVAILABILITY GROUP run *there* clears. Removing a replica and then dropping the group on the primary therefore still leaves the group listed on the instance that was removed — verified against SQL Server 2025.
func (*AvailabilityGroup) RemoveReplicaContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) RemoveReplicaContext(ctx context.Context, serverName string) error
RemoveReplicaContext is the context-aware variant of RemoveReplica.
func (*AvailabilityGroup) ReplicaSeq ¶ added in v0.0.9
func (ag *AvailabilityGroup) ReplicaSeq(ctx context.Context) iter.Seq2[*AvailabilityReplica, error]
ReplicaSeq returns an iterator over the availability group's replicas.
func (*AvailabilityGroup) Replicas ¶ added in v0.0.9
func (ag *AvailabilityGroup) Replicas() ([]*AvailabilityReplica, error)
Replicas returns every replica in the group, ordered by server name.
func (*AvailabilityGroup) ReplicasContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) ReplicasContext(ctx context.Context) ([]*AvailabilityReplica, error)
ReplicasContext is the context-aware variant of Replicas.
func (*AvailabilityGroup) ResumeDatabase ¶ added in v0.0.9
func (ag *AvailabilityGroup) ResumeDatabase(name string) error
ResumeDatabase resumes data movement for one database, on the same scope SuspendDatabase used.
func (*AvailabilityGroup) ResumeDatabaseContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) ResumeDatabaseContext(ctx context.Context, name string) error
ResumeDatabaseContext is the context-aware variant of ResumeDatabase.
func (*AvailabilityGroup) Server ¶ added in v0.0.9
func (ag *AvailabilityGroup) Server() *Server
Server returns the connection this availability group was read from.
func (*AvailabilityGroup) SetAutomatedBackupPreference ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetAutomatedBackupPreference(pref string) error
SetAutomatedBackupPreference chooses where automated backups of this group's databases should run: PRIMARY, SECONDARY_ONLY, SECONDARY (prefer a secondary but fall back to the primary) or NONE (any replica).
The preference is advisory. SQL Server does not enforce it — it is exposed to backup jobs through sys.fn_hadr_backup_is_preferred_replica, which the job has to consult.
func (*AvailabilityGroup) SetAutomatedBackupPreferenceContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetAutomatedBackupPreferenceContext(ctx context.Context, pref string) error
SetAutomatedBackupPreferenceContext is the context-aware variant of SetAutomatedBackupPreference.
func (*AvailabilityGroup) SetDBFailover ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetDBFailover(on bool) error
SetDBFailover turns database-level health detection on or off: with it on, a single database going offline triggers failover of the whole group.
func (*AvailabilityGroup) SetDBFailoverContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetDBFailoverContext(ctx context.Context, on bool) error
SetDBFailoverContext is the context-aware variant of SetDBFailover.
func (*AvailabilityGroup) SetDTCSupport ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetDTCSupport(perDB bool) error
SetDTCSupport turns per-database DTC support on (PER_DB) or off (NONE). SQL Server 2016+.
func (*AvailabilityGroup) SetDTCSupportContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetDTCSupportContext(ctx context.Context, perDB bool) error
SetDTCSupportContext is the context-aware variant of SetDTCSupport.
func (*AvailabilityGroup) SetFailureConditionLevel ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetFailureConditionLevel(level int) error
SetFailureConditionLevel sets how severe a condition must be before an automatic failover is triggered, 1 (server down only) to 5 (any qualifying internal error).
func (*AvailabilityGroup) SetFailureConditionLevelContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetFailureConditionLevelContext(ctx context.Context, level int) error
SetFailureConditionLevelContext is the context-aware variant of SetFailureConditionLevel.
func (*AvailabilityGroup) SetHealthCheckTimeout ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetHealthCheckTimeout(ms int) error
SetHealthCheckTimeout sets how long, in milliseconds, the cluster waits for sp_server_diagnostics before declaring the instance unresponsive. SQL Server enforces a 15000 ms floor.
func (*AvailabilityGroup) SetHealthCheckTimeoutContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetHealthCheckTimeoutContext(ctx context.Context, ms int) error
SetHealthCheckTimeoutContext is the context-aware variant of SetHealthCheckTimeout.
func (*AvailabilityGroup) SetListenerPort ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetListenerPort(dnsName string, port int) error
SetListenerPort changes the port an existing listener answers on. Run against the primary.
Clients already connected through the old port stay connected; only new connections are affected, and any that name the port explicitly will need updating.
func (*AvailabilityGroup) SetListenerPortContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetListenerPortContext(ctx context.Context, dnsName string, port int) error
SetListenerPortContext is the context-aware variant of SetListenerPort.
func (*AvailabilityGroup) SetRequiredSynchronizedSecondariesToCommit ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetRequiredSynchronizedSecondariesToCommit(n int) error
SetRequiredSynchronizedSecondariesToCommit sets how many synchronous secondaries must acknowledge a transaction before it commits on the primary. SQL Server 2017+.
Raising it above the number of healthy synchronous secondaries stops the primary accepting writes, which is the intended trade for guaranteed zero-data-loss failover — it is not a setting to nudge experimentally on a live group.
func (*AvailabilityGroup) SetRequiredSynchronizedSecondariesToCommitContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) SetRequiredSynchronizedSecondariesToCommitContext(ctx context.Context, n int) error
SetRequiredSynchronizedSecondariesToCommitContext is the context-aware variant of SetRequiredSynchronizedSecondariesToCommit.
func (*AvailabilityGroup) SuspendDatabase ¶ added in v0.0.9
func (ag *AvailabilityGroup) SuspendDatabase(name string) error
SuspendDatabase suspends data movement for one database.
The scope depends on where it runs, and the difference matters: on a secondary it suspends that one secondary, on the primary it suspends the database on *every* secondary. Either way the primary keeps accepting writes and its log cannot be truncated while movement is suspended, so a long suspension fills the log drive.
func (*AvailabilityGroup) SuspendDatabaseContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) SuspendDatabaseContext(ctx context.Context, name string) error
SuspendDatabaseContext is the context-aware variant of SuspendDatabase.
func (*AvailabilityGroup) UnjoinDatabase ¶ added in v0.0.9
func (ag *AvailabilityGroup) UnjoinDatabase(name string) error
UnjoinDatabase removes this instance's secondary copy of a database from the group, leaving it in the RESTORING state.
Run against the secondary. This is the per-secondary counterpart of RemoveDatabase: it takes one copy out of the group and leaves the database in it on every other replica.
func (*AvailabilityGroup) UnjoinDatabaseContext ¶ added in v0.0.9
func (ag *AvailabilityGroup) UnjoinDatabaseContext(ctx context.Context, name string) error
UnjoinDatabaseContext is the context-aware variant of UnjoinDatabase.
type AvailabilityGroupListener ¶ added in v0.0.9
type AvailabilityGroupListener struct {
GroupID string
ListenerID string
DNSName string
Port int
// IsConformant is false for a listener created outside SQL Server (added
// directly in the cluster manager), whose configuration SQL Server can
// report but not fully validate.
IsConformant bool
IPConfigurationString string
IsDistributedNetworkName bool
IPAddresses []AvailabilityListenerIP
}
AvailabilityGroupListener is one virtual network name clients connect to. Its addresses are carried inline rather than behind another round trip, since a listener without them tells a caller almost nothing.
type AvailabilityListenerIP ¶ added in v0.0.9
AvailabilityListenerIP is one address bound to a listener. A multi-subnet availability group has one per subnet.
type AvailabilityListenerIPSpec ¶ added in v0.0.9
type AvailabilityListenerIPSpec struct {
IPAddress string
// SubnetMask is required for IPv4 and must be empty for IPv6.
SubnetMask string
}
AvailabilityListenerIPSpec is one static address for a listener being created.
type AvailabilityListenerSpec ¶ added in v0.0.9
type AvailabilityListenerSpec struct {
// DNSName is the virtual network name clients connect to. Required.
DNSName string
// Port is the TCP port the listener answers on. Zero omits PORT from the
// statement, which SQL Server defaults to 1433.
Port int
// IPAddresses are the static addresses to bind, one per subnet. An entry
// with an empty SubnetMask is emitted as an IPv6 address, which takes no
// mask; an IPv4 entry needs one.
IPAddresses []AvailabilityListenerIPSpec
// DHCP requests an address from DHCP instead of binding static ones.
// Mutually exclusive with IPAddresses.
DHCP bool
// DHCPSubnet and DHCPSubnetMask optionally name the subnet to take the
// address from — WITH DHCP ON (N'network', N'mask'). Both or neither.
DHCPSubnet string
DHCPSubnetMask string
}
AvailabilityListenerSpec describes a listener to create with AddListener.
Exactly one addressing mode has to be chosen: either DHCP, or one or more static IPAddresses. A group can have only one listener at a time, so adding a second is an error (19477) rather than a second name to reach it by.
type AvailabilityReplica ¶ added in v0.0.9
type AvailabilityReplica struct {
GroupID string
// GroupName is the owning group's name. ALTER AVAILABILITY GROUP addresses
// a replica as "<group> MODIFY REPLICA ON '<replica>'", so every setter on
// this type needs it; it is filled in by ReplicasContext.
GroupName string
ReplicaID string
ReplicaServerName string
EndpointURL string
AvailabilityMode string
FailoverMode string
SessionTimeout int
PrimaryRoleAllowConnections string
SecondaryRoleAllowConnections string
BackupPriority int
ReadOnlyRoutingURL string
// SeedingMode is AUTOMATIC or MANUAL. SQL Server 2016+; empty on older.
SeedingMode string
CreateDate time.Time
ModifyDate time.Time
IsLocal bool
Role string
OperationalState string
ConnectedState string
RecoveryHealth string
SynchronizationHealth string
LastConnectErrorNumber int
LastConnectErrorDescription string
LastConnectErrorTimestamp time.Time
// contains filtered or unexported fields
}
AvailabilityReplica is one replica's configuration plus, where the local instance can see it, its current state.
The state fields (Role, OperationalState, ConnectedState, RecoveryHealth, SynchronizationHealth) come from sys.dm_hadr_availability_replica_states and are empty for a replica this instance has no state row for. OperationalState in particular is only ever populated for the local replica — SQL Server does not report a remote replica's operational state — so an empty value there is normal rather than a fault.
func (*AvailabilityReplica) Drop ¶ added in v0.0.9
func (r *AvailabilityReplica) Drop() error
Drop removes this replica from its availability group — the same statement AvailabilityGroup.RemoveReplica issues, addressed from the replica instead. Run against the primary.
func (*AvailabilityReplica) DropContext ¶ added in v0.0.9
func (r *AvailabilityReplica) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
func (*AvailabilityReplica) ReadOnlyRoutingList ¶ added in v0.0.9
func (r *AvailabilityReplica) ReadOnlyRoutingList() ([][]string, error)
ReadOnlyRoutingList returns the read-only routing list this replica uses while it holds the primary role: the secondaries read-intent connections are redirected to, in priority order.
The outer slice is the priority order; each inner slice holds the replicas sharing one priority, which SQL Server load-balances between (2016+). A replica with no routing list configured returns nil, not an error.
func (*AvailabilityReplica) ReadOnlyRoutingListContext ¶ added in v0.0.9
func (r *AvailabilityReplica) ReadOnlyRoutingListContext(ctx context.Context) ([][]string, error)
ReadOnlyRoutingListContext is the context-aware variant of ReadOnlyRoutingList.
func (*AvailabilityReplica) SetAvailabilityMode ¶ added in v0.0.9
func (r *AvailabilityReplica) SetAvailabilityMode(mode string) error
SetAvailabilityMode switches the replica between SYNCHRONOUS_COMMIT, ASYNCHRONOUS_COMMIT and CONFIGURATION_ONLY.
Only a synchronous-commit replica can be an automatic failover target, so dropping one to asynchronous also silently removes it as a candidate.
func (*AvailabilityReplica) SetAvailabilityModeContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetAvailabilityModeContext(ctx context.Context, mode string) error
SetAvailabilityModeContext is the context-aware variant of SetAvailabilityMode.
func (*AvailabilityReplica) SetBackupPriority ¶ added in v0.0.9
func (r *AvailabilityReplica) SetBackupPriority(priority int) error
SetBackupPriority sets this replica's automated-backup priority, 1 (lowest) to 100 (highest). 0 excludes the replica from automated backups altogether — the value behind SSMS's "Exclude Replica" checkbox.
func (*AvailabilityReplica) SetBackupPriorityContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetBackupPriorityContext(ctx context.Context, priority int) error
SetBackupPriorityContext is the context-aware variant of SetBackupPriority.
func (*AvailabilityReplica) SetFailoverMode ¶ added in v0.0.9
func (r *AvailabilityReplica) SetFailoverMode(mode string) error
SetFailoverMode switches the replica between AUTOMATIC, MANUAL and EXTERNAL failover. EXTERNAL is the only mode a group with ClusterType EXTERNAL accepts, since the cluster manager owns failover there.
func (*AvailabilityReplica) SetFailoverModeContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetFailoverModeContext(ctx context.Context, mode string) error
SetFailoverModeContext is the context-aware variant of SetFailoverMode.
func (*AvailabilityReplica) SetPrimaryRoleAllowConnections ¶ added in v0.0.9
func (r *AvailabilityReplica) SetPrimaryRoleAllowConnections(mode string) error
SetPrimaryRoleAllowConnections sets which connections the replica accepts while it is the primary: ALL, or READ_WRITE (which turns away connections asking for ApplicationIntent=ReadOnly).
func (*AvailabilityReplica) SetPrimaryRoleAllowConnectionsContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetPrimaryRoleAllowConnectionsContext(ctx context.Context, mode string) error
SetPrimaryRoleAllowConnectionsContext is the context-aware variant of SetPrimaryRoleAllowConnections.
func (*AvailabilityReplica) SetReadOnlyRoutingList ¶ added in v0.0.9
func (r *AvailabilityReplica) SetReadOnlyRoutingList(list [][]string) error
SetReadOnlyRoutingList sets the routing list this replica uses while it holds the primary role, in the shape ReadOnlyRoutingListContext returns: the outer slice is priority order, and replicas sharing an inner slice are load-balanced between (SQL Server 2016+). An empty list clears the routing list.
func (*AvailabilityReplica) SetReadOnlyRoutingListContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetReadOnlyRoutingListContext(ctx context.Context, list [][]string) error
SetReadOnlyRoutingListContext is the context-aware variant of SetReadOnlyRoutingList.
func (*AvailabilityReplica) SetReadOnlyRoutingURL ¶ added in v0.0.9
func (r *AvailabilityReplica) SetReadOnlyRoutingURL(url string) error
SetReadOnlyRoutingURL sets the address read-intent connections are redirected to when this replica is a readable secondary, e.g. "TCP://ubusql2.example.com:1433". An empty url clears it.
The URL is a property of the *secondary* role, while the routing list that points at it is a property of the primary role — see SetReadOnlyRoutingList. Both have to be set for read-only routing to work.
Clearing writes the bare keyword NONE, matching the routing list. Neither NULL nor an empty string works: NULL is a syntax error and N” is rejected as "Invalid usage of the option READ_ONLY_ROUTING_URL" — both verified against SQL Server 2025.
func (*AvailabilityReplica) SetReadOnlyRoutingURLContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetReadOnlyRoutingURLContext(ctx context.Context, url string) error
SetReadOnlyRoutingURLContext is the context-aware variant of SetReadOnlyRoutingURL.
func (*AvailabilityReplica) SetSecondaryRoleAllowConnections ¶ added in v0.0.9
func (r *AvailabilityReplica) SetSecondaryRoleAllowConnections(mode string) error
SetSecondaryRoleAllowConnections sets whether the replica is readable while it is a secondary: NO, READ_ONLY (read-intent connections only) or ALL.
func (*AvailabilityReplica) SetSecondaryRoleAllowConnectionsContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetSecondaryRoleAllowConnectionsContext(ctx context.Context, mode string) error
SetSecondaryRoleAllowConnectionsContext is the context-aware variant of SetSecondaryRoleAllowConnections.
func (*AvailabilityReplica) SetSeedingMode ¶ added in v0.0.9
func (r *AvailabilityReplica) SetSeedingMode(mode string) error
SetSeedingMode switches the replica between AUTOMATIC (direct seeding) and MANUAL (backup and restore) database seeding. SQL Server 2016+.
func (*AvailabilityReplica) SetSeedingModeContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetSeedingModeContext(ctx context.Context, mode string) error
SetSeedingModeContext is the context-aware variant of SetSeedingMode.
func (*AvailabilityReplica) SetSessionTimeout ¶ added in v0.0.9
func (r *AvailabilityReplica) SetSessionTimeout(seconds int) error
SetSessionTimeout sets how many seconds a replica waits for a message from its partner before reporting the connection down. SQL Server enforces a 5-second floor; below about 10 seconds a busy system reports false failures.
func (*AvailabilityReplica) SetSessionTimeoutContext ¶ added in v0.0.9
func (r *AvailabilityReplica) SetSessionTimeoutContext(ctx context.Context, seconds int) error
SetSessionTimeoutContext is the context-aware variant of SetSessionTimeout.
type AvailabilityReplicaSpec ¶ added in v0.0.9
type AvailabilityReplicaSpec struct {
// ServerName is the instance name, as @@SERVERNAME reports it there.
// Required — it is how every later ALTER addresses this replica.
ServerName string
// EndpointURL is the replica's database mirroring endpoint address,
// "tcp://host:port". Required; DatabaseMirroringEndpoint.URL builds it.
EndpointURL string
// AvailabilityMode is SYNCHRONOUS_COMMIT, ASYNCHRONOUS_COMMIT or
// CONFIGURATION_ONLY. Empty means SYNCHRONOUS_COMMIT.
AvailabilityMode string
// FailoverMode is MANUAL, AUTOMATIC or EXTERNAL. Empty means MANUAL.
// EXTERNAL is required — and the only legal value — under
// CLUSTER_TYPE = EXTERNAL.
FailoverMode string
// SeedingMode is AUTOMATIC or MANUAL. Empty omits the clause, which the
// server defaults to MANUAL.
SeedingMode string
// BackupPriority is 0-100; 0 excludes the replica from automated backups.
// Negative omits the clause, leaving the server's default of 50 — which is
// why this is not simply "0 means default".
BackupPriority int
// SessionTimeout is the seconds a replica waits for a partner before
// declaring the connection dead. Zero omits the clause (server default 10).
SessionTimeout int
// PrimaryRoleAllowConnections is ALL or READ_WRITE; empty omits the clause.
PrimaryRoleAllowConnections string
// SecondaryRoleAllowConnections is NO, READ_ONLY or ALL; empty omits it.
SecondaryRoleAllowConnections string
// ReadOnlyRoutingURL is this replica's routing address for read-intent
// redirection, set inside SECONDARY_ROLE. Empty omits it.
ReadOnlyRoutingURL string
}
AvailabilityReplicaSpec describes one replica of a group being created.
type BackupAction ¶
type BackupAction string
BackupAction mirrors SQL Server backup types.
const ( BackupActionDatabase BackupAction = "DATABASE" BackupActionLog BackupAction = "LOG" BackupActionFiles BackupAction = "FILES" BackupActionDifferential BackupAction = "DATABASE_DIFFERENTIAL" )
type BackupFile ¶ added in v0.0.5
type BackupFile struct {
LogicalName string
PhysicalName string
Type string // "D" data, "L" log, "F" full-text, "S" FILESTREAM
FileGroupName string
Size int64 // bytes
MaxSize int64 // bytes
}
BackupFile describes one database file inside a backup set, as reported by RESTORE FILELISTONLY.
type BackupHeader ¶ added in v0.0.5
type BackupHeader struct {
BackupName string
Description string
BackupType BackupAction
Position int
DatabaseName string
ServerName string
BackupStart time.Time
BackupFinish time.Time
BackupSize int64 // bytes
CompressedSize int64 // bytes; equals BackupSize when not compressed
Compressed bool
HasChecksums bool
IsCopyOnly bool
DatabaseVersion int
CompatibilityLevel CompatibilityLevel
SoftwareVersionMajor int
RecoveryModel string
}
BackupHeader describes one backup set on a backup device, as reported by RESTORE HEADERONLY.
type BackupInfo ¶
type BackupInfo struct {
DatabaseName string
BackupSetName string
Description string
BackupType BackupAction
BackupStart time.Time
BackupFinish time.Time
BackupSize int64
DeviceName string
UserName string
ServerName string
DatabaseVersion int
CompatibilityLevel CompatibilityLevel
}
BackupInfo holds metadata about a specific database backup.
type BackupOptions ¶
type BackupOptions struct {
// Database to back up (required).
Database string
// Action: DATABASE (default), LOG, or FILES.
Action BackupAction
// Files and FileGroups name the logical files / filegroups a
// BackupActionFiles backup covers. At least one of the two is required
// for that action and both are ignored for every other one — there is no
// "BACKUP FILES" verb in T-SQL; a file/filegroup backup is a BACKUP
// DATABASE carrying FILE = / FILEGROUP = clauses.
Files []string
FileGroups []string
// Devices is one or more backup device paths, e.g. `C:\Backups\MyDB.bak`.
Devices []string
// BackupSetName is the NAME clause.
BackupSetName string
// Description is the DESCRIPTION clause.
Description string
// MediaDescription is the MEDIADESCRIPTION clause.
MediaDescription string
// Compression: nil = server default, new(true) = force on, new(false) = force off.
Compression *bool
// CopyOnly marks this as a copy-only backup (does not break the log chain).
CopyOnly bool
// Checksum adds WITH CHECKSUM.
Checksum bool
// Format reinitialises the media.
Format bool
// Init overwrites existing backup sets on the media.
Init bool
// Stats controls progress reporting frequency (e.g. 10 = every 10%).
// If Progress is set and Stats is left at 0, it defaults to 10 so
// percent-complete messages actually get emitted.
Stats int
// Progress, if set, is called for every message SQL Server emits while
// the backup runs, including the "N percent processed" notices STATS
// produces — pct is -1 for a message that doesn't carry a percentage.
Progress func(pct int, message string)
}
BackupOptions configures a BACKUP DATABASE or BACKUP LOG operation.
type BulkCopy ¶ added in v0.0.4
type BulkCopy struct {
// Schema is the destination schema; empty defaults to "dbo".
Schema string
// Table is the destination table name (unquoted).
Table string
// Columns are the destination columns, in the order each row supplies
// its values. Required.
Columns []string
// Options tunes the load; the zero value is fine.
Options BulkOptions
}
BulkCopy describes the destination of a bulk-insert load.
type BulkOptions ¶ added in v0.0.4
type BulkOptions struct {
// CheckConstraints enforces CHECK and FOREIGN KEY constraints on the
// incoming rows. Off by default (as with bcp), which is faster but can
// admit rows a normal INSERT would reject.
CheckConstraints bool
// FireTriggers fires AFTER INSERT triggers on the destination table.
// Off by default, so triggers do not run during the load.
FireTriggers bool
// KeepNulls keeps NULLs supplied by the source instead of substituting
// the destination column's DEFAULT.
KeepNulls bool
// TableLock takes a bulk-update (BU) lock on the table for the duration
// of the load rather than acquiring row/page locks — faster for a
// dedicated import.
TableLock bool
// RowsPerBatch hints the number of rows per batch sent to the server.
// Zero lets the server decide.
RowsPerBatch int
// KilobytesPerBatch hints the batch size in kilobytes. Zero lets the
// server decide.
KilobytesPerBatch int
// Order names the columns the source rows are already sorted by (each
// entry a column optionally followed by " ASC"/" DESC"). When it matches
// the destination's clustered index the server can skip an internal sort.
Order []string
}
BulkOptions tunes a bulk-copy load, mirroring the WITH options of T-SQL's INSERT BULK. The zero value performs a plain load with server defaults.
type Capabilities ¶ added in v0.0.10
type Capabilities struct {
// ServerRoles maps each name in ProbedServerRoles to membership.
ServerRoles map[string]bool
// ServerPermissions maps each name in ProbedServerPermissions to its state.
ServerPermissions map[string]CapabilityState
}
Capabilities is what the connected login may do at the server scope: its fixed-server-role memberships and the state of each permission in ProbedServerPermissions.
Obtain one with Server.Capabilities. Every method is nil-safe, so a caller that could not probe — or chose not to — can hold a nil *Capabilities and still ask questions of it.
func (*Capabilities) Allows ¶ added in v0.0.10
func (c *Capabilities) Allows(name string) bool
Allows reports that the permission is not known to be denied — granted, or unknown. Use it to decide whether to *withhold* something.
The asymmetry with Has is the whole point, and gating on the wrong one is the mistake this pair exists to prevent. A probe that failed, or an instance that does not define the permission, leaves every answer Unknown; gating a menu item on Has would then hide the entire application from a login that may well be a sysadmin. The server remains the authority — withholding is only ever a courtesy, and it must fail open.
func (*Capabilities) Has ¶ added in v0.0.10
func (c *Capabilities) Has(name string) bool
Has reports that the permission is known to be held. Use it to *offer* something extra.
func (*Capabilities) InServerRole ¶ added in v0.0.10
func (c *Capabilities) InServerRole(name string) bool
InServerRole reports whether the login is a member of the named fixed server role.
sysadmin is *not* folded in, because SQL Server does not fold it in either: IS_SRVROLEMEMBER('SQLAgentUserRole') is 0 for sa. Where a feature accepts either, ask for both. Permissions need no such care — HAS_PERMS_BY_NAME already answers 1 for a sysadmin on every server permission.
func (*Capabilities) IsSysadmin ¶ added in v0.0.10
func (c *Capabilities) IsSysadmin() bool
IsSysadmin reports membership in the sysadmin fixed server role.
func (*Capabilities) Permission ¶ added in v0.0.10
func (c *Capabilities) Permission(name string) CapabilityState
Permission returns the state of one server permission. A name that was never probed — including a misspelt one — is CapabilityUnknown.
func (*Capabilities) Probed ¶ added in v0.0.10
func (c *Capabilities) Probed() bool
Probed reports whether these capabilities came from a server that answered.
The zero value and a failed probe are both "nothing known", and every permission accessor already treats that as unknown — but a *role* test cannot: InServerRole answers false for a role that was never asked about, exactly as it does for one the login is not in. A caller that would withhold something on "not a member" must check this first, or an unprobed connection silently loses whatever the role guards.
type CapabilityState ¶ added in v0.0.10
type CapabilityState int
CapabilityState is the answer to "does the connected login hold this permission?" — the three-way answer HAS_PERMS_BY_NAME actually gives.
The third state is not padding. HAS_PERMS_BY_NAME returns NULL, without raising an error, for a permission name the instance does not define, so a permission introduced in a later version reads as CapabilityUnknown on an older one rather than as denied. A caller that folds Unknown into Denied hides a feature on every instance that has it under a different name.
const ( // CapabilityUnknown means the answer is not available: the permission is // not one this instance defines, or it was never probed, or the probe // itself failed. It is not a denial — see Capabilities.Allows. CapabilityUnknown CapabilityState = iota // CapabilityGranted means the login holds the permission, whether // directly, through a role, or through a wider permission that implies // it. CapabilityGranted // CapabilityDenied means the instance was asked and said no. CapabilityDenied )
func (CapabilityState) String ¶ added in v0.0.10
func (s CapabilityState) String() string
type Catalog ¶ added in v0.0.5
type Catalog struct {
Schemas []string
Objects []CatalogObject
}
Catalog is a bulk snapshot of every user table and view in a database, each with its columns already loaded — see Database.Catalog.
type CatalogColumn ¶ added in v0.0.5
type CatalogColumn struct {
Name string
DataType DataType
MaxLength int
Precision int
Scale int
IsNullable bool
}
CatalogColumn is one column of a CatalogObject — the subset of Column's fields relevant to identifying and describing a column, without the per-table detail (identity, computed, default, rowguid) that a bulk snapshot has no need for.
type CatalogObject ¶ added in v0.0.5
type CatalogObject struct {
ObjectID int
Schema string
Name string
Type CatalogObjectType
Columns []CatalogColumn
}
CatalogObject is one table or view and its columns, in ordinal order.
type CatalogObjectType ¶ added in v0.0.5
type CatalogObjectType int
CatalogObjectType distinguishes a Catalog entry's underlying object kind.
const ( CatalogTable CatalogObjectType = iota CatalogView )
type Category ¶ added in v0.0.6
type Category struct {
ID int
Class CategoryClass
Name string
}
Category represents a SQL Server Agent job, alert, or operator category (msdb.dbo.syscategories) — Class says which.
type CategoryClass ¶ added in v0.0.6
type CategoryClass string
CategoryClass is the msdb.dbo.syscategories.category_class value a Category belongs to — also the literal sp_add_category/sp_delete_category @class parameter.
const ( CategoryClassJob CategoryClass = "JOB" CategoryClassAlert CategoryClass = "ALERT" CategoryClassOperator CategoryClass = "OPERATOR" )
type Certificate ¶ added in v0.0.9
type Certificate struct {
Name string
CertificateID int
PrincipalID int
// Subject is the certificate's subject as SQL Server decoded it.
Subject string
// PvtKeyEncryptionType is how the private key is protected —
// "ENCRYPTED_BY_MASTER_KEY", "ENCRYPTED_BY_PASSWORD", or "NO_PRIVATE_KEY"
// for one imported from a public certificate alone. An endpoint's own
// certificate must be ENCRYPTED_BY_MASTER_KEY, because the private key has
// to be openable without anyone typing a password.
PvtKeyEncryptionType string
StartDate time.Time
ExpiryDate time.Time
Thumbprint []byte
// contains filtered or unexported fields
}
Certificate mirrors a row of sys.certificates.
func (*Certificate) Drop ¶ added in v0.0.9
func (c *Certificate) Drop() error
Drop deletes the certificate.
func (*Certificate) DropContext ¶ added in v0.0.9
func (c *Certificate) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
func (*Certificate) Encoded ¶ added in v0.0.9
func (c *Certificate) Encoded() ([]byte, error)
Encoded returns the ASN.1-encoded public certificate — what CreateCertificate's FromBinary takes, and the whole of what one instance needs to give another to authenticate it. The private key is not included and cannot be obtained this way.
func (*Certificate) EncodedContext ¶ added in v0.0.9
func (c *Certificate) EncodedContext(ctx context.Context) ([]byte, error)
EncodedContext is the context-aware variant of Encoded.
func (*Certificate) HasPrivateKey ¶ added in v0.0.9
func (c *Certificate) HasPrivateKey() bool
HasPrivateKey reports whether this instance holds the certificate's private key, i.e. can present it rather than only verify against it.
type CertificateSpec ¶ added in v0.0.9
type CertificateSpec struct {
Name string
// Authorization is the database user that will own the certificate. Empty
// leaves it owned by the caller. An imported peer certificate is normally
// owned by a user created for it, so that CONNECT on the endpoint can be
// granted to that user's login.
Authorization string
// Subject is the certificate subject for a newly generated certificate.
Subject string
// StartDate and ExpiryDate bound a newly generated certificate. Zero
// values omit the clause, which SQL Server defaults to one year from now.
StartDate time.Time
ExpiryDate time.Time
// EncryptionPassword protects the new certificate's private key with a
// password instead of the database master key. Leave it empty for an
// endpoint certificate: the private key has to open without a password.
EncryptionPassword string
// FromBinary is an ASN.1-encoded public certificate, as returned by
// Certificate.Encoded. Mutually exclusive with Subject.
FromBinary []byte
}
CertificateSpec describes a certificate to create.
Exactly one origin: either FromBinary, which imports an existing public certificate, or a Subject, which has SQL Server generate a new key pair.
type ChangeTrackingInfo ¶ added in v0.0.4
type ChangeTrackingInfo struct {
Enabled bool
AutoCleanup bool
RetentionPeriod int
RetentionUnit string // e.g. "DAYS", "HOURS", "MINUTES"
}
ChangeTrackingInfo holds database-level change tracking settings.
type CheckConstraint ¶
type CheckConstraint struct {
Name string
Definition string
IsDisabled bool
Column string // empty for table-level checks
}
CheckConstraint represents a CHECK constraint.
type Column ¶
type Column struct {
Name string
OrdinalPosition int
DataType DataType
MaxLength int // -1 = MAX
Precision int
Scale int
IsNullable bool
IsIdentity bool
IdentitySeed int64
IdentityIncrement int64
IsComputed bool
ComputedText string
DefaultValue *ColumnDefault
IsRowGUID bool
Collation string
IsPrimaryKey bool
}
Column mirrors Microsoft.SqlServer.Management.Smo.Column.
type ColumnDefault ¶
ColumnDefault represents a column default constraint.
type ColumnDefinition ¶
type ColumnDefinition struct {
Name string
DataType DataType
MaxLength int // char/varchar/nchar/nvarchar: 0 = omit, -1 = MAX
Precision int // decimal/numeric
Scale int // decimal/numeric / datetime2 / time
IsNullable bool
IsIdentity bool
IdentitySeed int64
IdentityIncr int64
DefaultValue string // expression, e.g. "sysdatetime()" or "0"
IsPrimaryKey bool
}
ColumnDefinition describes a column in a CREATE TABLE statement.
type ColumnEncryptionKey ¶
type ColumnEncryptionKey struct {
Name string
ID int
// MasterKeyName and EncryptionAlgorithm describe the key's first
// encrypted value — the common case, where a key has exactly one.
MasterKeyName string
EncryptionAlgorithm string
// Values holds every encrypted value of the key, one per column master
// key it is encrypted under. A key has two while its master key is being
// rotated, and CREATE COLUMN ENCRYPTION KEY has to restate all of them.
Values []*ColumnEncryptionKeyValue
// contains filtered or unexported fields
}
ColumnEncryptionKey mirrors sys.column_encryption_keys.
func (*ColumnEncryptionKey) Drop ¶
func (cek *ColumnEncryptionKey) Drop() error
Drop drops the column encryption key.
func (*ColumnEncryptionKey) DropContext ¶ added in v0.0.5
func (cek *ColumnEncryptionKey) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
type ColumnEncryptionKeyValue ¶ added in v0.0.10
type ColumnEncryptionKeyValue struct {
MasterKeyName string
EncryptionAlgorithm string
// EncryptedValue is the key material encrypted under the master key.
// Scripting the key means reproducing these bytes exactly; nothing can
// regenerate them.
EncryptedValue []byte
}
ColumnEncryptionKeyValue is one encrypted value of a column encryption key, from sys.column_encryption_key_values.
type ColumnMasterKey ¶
type ColumnMasterKey struct {
Name string
ID int
KeyStoreProviderName string
KeyPath string
AllowEnclaveComputations bool
// Signature is the digital signature over the key's metadata, required
// verbatim by CREATE COLUMN MASTER KEY's ENCLAVE_COMPUTATIONS clause —
// it can't be recomputed from the other fields, so a key that allows
// enclave computations cannot be scripted without it. Empty for a key
// that doesn't.
Signature []byte
// contains filtered or unexported fields
}
ColumnMasterKey mirrors sys.column_master_keys.
func (*ColumnMasterKey) Drop ¶
func (cmk *ColumnMasterKey) Drop() error
Drop drops the column master key.
func (*ColumnMasterKey) DropContext ¶ added in v0.0.5
func (cmk *ColumnMasterKey) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
type ColumnPermissionEntry ¶ added in v0.0.8
type ColumnPermissionEntry struct {
Principal string
PrincipalType string // e.g. "DATABASE_ROLE", "SQL_USER"
Grantor string
Schema string
Object string
// ObjectType is what the column's parent is — "TABLE" or "VIEW", the
// same values PrincipalSecurable.SecurableType uses, so a caller can key
// both against one securable identity. Both types carry column
// permissions and sys.database_permissions records them identically, so
// without this a view's grants get mistaken for a table's.
ObjectType string
Column string
Permission ObjectPermission
State PermissionState // "GRANT", "GRANT_WITH_GRANT_OPTION", "DENY"
}
ColumnPermissionEntry is one GRANT/DENY entry recorded on a single column of a table or view — what sys.database_permissions stores as an OBJECT_OR_COLUMN row with a non-zero minor_id. Object-level entries (minor_id 0) are reported by Permissions instead, and the two are genuinely separate grants: a column DENY overrides an object GRANT.
type CompatibilityLevel ¶
type CompatibilityLevel int
CompatibilityLevel mirrors SQL Server database compatibility levels.
const ( CompatLevel2008 CompatibilityLevel = 100 CompatLevel2012 CompatibilityLevel = 110 CompatLevel2014 CompatibilityLevel = 120 CompatLevel2016 CompatibilityLevel = 130 CompatLevel2017 CompatibilityLevel = 140 CompatLevel2019 CompatibilityLevel = 150 CompatLevel2022 CompatibilityLevel = 160 CompatLevel2025 CompatibilityLevel = 170 )
type ConfigurationOption ¶
type ConfigurationOption struct {
ConfigID int
Name string
Value int64
ValueInUse int64
Minimum int64
Maximum int64
IsDynamic bool // true = change takes effect without a restart
IsAdvanced bool
Description string
// contains filtered or unexported fields
}
ConfigurationOption mirrors a row from sys.configurations.
func (*ConfigurationOption) SetValue ¶
func (c *ConfigurationOption) SetValue(value int64) error
SetValue changes the option value using sp_configure. For non-dynamic options, call Server.Reconfigure() afterwards.
func (*ConfigurationOption) SetValueContext ¶
func (c *ConfigurationOption) SetValueContext(ctx context.Context, value int64) error
SetValueContext is the context-aware variant of SetValue.
type ConnectionOptions ¶
type ConnectionOptions struct {
// Server is the host[:port] or host\instance, e.g. "localhost:1433" or
// "myserver.database.windows.net". Required.
Server string
// Database to connect to initially. Defaults to "master".
Database string
// Auth selects the authentication strategy. Defaults to AuthSQLServer.
Auth AuthMethod
// User is the SQL Server login, Windows UPN, or Entra app client ID,
// depending on the Auth method chosen.
User string
// Password is the SQL Server password, Entra user password, or client secret.
Password string
// TenantID is the Entra tenant (directory) ID. Required for service principal
// methods when the tenant differs from the server tenant.
TenantID string
// ClientID selects a user-assigned Managed Identity when Auth=AuthEntraMSI.
ClientID string
// ClientCertPath is the path to a PEM/PFX certificate for
// Auth=AuthEntraServicePrincipal certificate-based auth.
ClientCertPath string
// ClientCertPassword is the private-key password for ClientCertPath.
ClientCertPassword string
// AccessToken is a pre-acquired bearer token for
// Auth=AuthEntraServicePrincipalAccessToken or AuthEntraOnBehalfOf.
// It is embedded once at connect time; prefer AccessTokenProvider when
// the token can expire during the connection's lifetime.
AccessToken string
// AccessTokenProvider, when set, is called to obtain a bearer token for
// each new pooled connection, so tokens that expire (e.g. Entra tokens,
// good for ~1 hour) are refreshed automatically rather than embedded
// once and going stale. It takes precedence over AccessToken and Auth:
// the token is presented directly to SQL Server, bypassing the fedauth
// DSN machinery, so it works for any scenario where the caller mints
// its own tokens. The error it returns aborts the connection attempt.
AccessTokenProvider func(ctx context.Context) (string, error)
// ApplicationClientID is the AAD enterprise application client ID registered
// by the tenant admin to allow interactive / device-code flows.
ApplicationClientID string
// ServerSPN overrides the Kerberos service principal name of the target
// instance (e.g. "MSSQLSvc/host.contoso.com:1433"). Used only with
// AuthWindows. Leave empty to let the driver derive it from the address,
// which is correct for most host:port connections.
ServerSPN string
// Kerberos configures Active Directory authentication for AuthWindows.
// It matters mainly on non-Windows hosts, where AuthWindows authenticates
// via Kerberos rather than native SSPI; see KerberosOptions. The zero
// value uses the host's ambient Kerberos setup (krb5.conf + kinit cache).
Kerberos KerberosOptions
// Encrypt controls the encryption mode.
// "" - driver default (true for Azure endpoints, false otherwise)
// "true" - always encrypt
// "false" - no encryption
// "disable" - no encryption (legacy alias)
// "strict" - TDS 8.0 strict encryption
Encrypt string
// TrustServerCertificate disables TLS certificate validation.
// Handy for dev/local instances; do not use in production.
TrustServerCertificate bool
// HostNameInCertificate overrides the expected server name in the TLS cert.
// Useful when connecting via IP address or when the cert CN differs.
HostNameInCertificate string
// DisableInstanceDiscovery disables OIDC instance discovery.
// Set true only for disconnected or private clouds (e.g. Azure Stack).
DisableInstanceDiscovery bool
// SendCertificateChain controls whether the full certificate chain is sent
// in token requests (needed for Subject Name/Issuer SNI auth).
SendCertificateChain bool
// TokenFilePath is the path to the Kubernetes service account token file
// for Auth=AuthEntraMSI (Workload Identity).
TokenFilePath string
// ConnectTimeout is the maximum time to wait for the initial connection.
// Defaults to 30s when zero.
ConnectTimeout time.Duration
// ApplicationName is shown in sys.dm_exec_sessions.program_name.
// Defaults to "gosmo".
ApplicationName string
// MaxOpenConns is the maximum number of open connections in the pool.
// 0 means unlimited.
MaxOpenConns int
// MaxIdleConns is the maximum number of idle connections kept in the pool.
// Defaults to 2.
MaxIdleConns int
// ConnMaxLifetime is the maximum lifetime of a pooled connection.
// 0 means unlimited.
ConnMaxLifetime time.Duration
// ConnMaxIdleTime is the maximum time a pooled connection may sit idle
// before it's closed and evicted rather than handed out again. This is
// what guards against a connection silently dropped while idle — a
// firewall/NAT idle timeout, a load balancer, or the server itself
// closing a long-idle session — sitting in the pool looking usable
// until something actually tries it and fails. Defaults to 5 minutes
// when zero.
ConnMaxIdleTime time.Duration
// SessionInitSQL is T-SQL executed on every pooled connection right
// after it is reset, before the first query runs on it. Use it to apply
// SET options that must hold for the whole session (the equivalent of
// SSMS's Query Execution options), e.g. "SET ARITHABORT ON; SET
// ANSI_NULLS ON". Leave empty for driver defaults.
SessionInitSQL string
}
ConnectionOptions holds every parameter needed to open a connection.
Authentication quick guide:
SQL Server login:
Auth: AuthSQLServer, User: "sa", Password: "..."
Windows / Kerberos (on-premises, domain-joined host):
Auth: AuthWindows (no User/Password needed)
On Linux/macOS this uses Kerberos; run "kinit" first for single sign-on, or set the Kerberos field for a keytab, realm, or custom krb5.conf.
Azure Managed Identity (system-assigned):
Auth: AuthEntraMSI, Server: "myserver.database.windows.net"
Azure Managed Identity (user-assigned):
Auth: AuthEntraMSI, ClientID: "<managed-identity-client-id>"
Service Principal (client secret):
Auth: AuthEntraServicePrincipal User: "<app-client-id>[@<tenant-id>]", Password: "<client-secret>" TenantID: "<tenant-id>"
Service Principal (certificate):
Auth: AuthEntraServicePrincipal User: "<app-client-id>[@<tenant-id>]", ClientCertPath: "/path/to/cert.pem"
Default credential chain (env vars -> MSI -> AzCLI):
Auth: AuthEntraDefault
Azure CLI credential (az login):
Auth: AuthEntraAzCLI
type CreateAlertRequest ¶ added in v0.0.6
type CreateAlertRequest struct {
Name string
Enabled bool
// ErrorNumber and Severity are mutually exclusive triggers — leave
// whichever isn't in use at 0.
ErrorNumber int
Severity int
DatabaseName string
DelayBetweenResponses time.Duration
NotificationMessage string
IncludeEventDescriptionIn int
Category string
}
CreateAlertRequest describes a new SQL Server event alert.
type CreateAvailabilityGroupRequest ¶ added in v0.0.9
type CreateAvailabilityGroupRequest struct {
// Name is the group's name. Required.
Name string
// ClusterType is WSFC, EXTERNAL or NONE. Empty omits the clause, which
// means WSFC — and fails on an instance with no Windows cluster under it,
// so Linux callers must set this.
ClusterType string
// AutomatedBackupPreference is PRIMARY, SECONDARY_ONLY, SECONDARY or NONE.
// Empty omits the clause.
AutomatedBackupPreference string
// FailureConditionLevel is 1-5; zero omits the clause.
FailureConditionLevel int
// HealthCheckTimeout is milliseconds; zero omits the clause.
HealthCheckTimeout int
// DBFailover turns on database-level health detection.
DBFailover bool
// DTCSupport requests DTC_SUPPORT = PER_DB.
DTCSupport bool
// RequiredSynchronizedSecondariesToCommit is SQL Server 2017+. Negative
// omits the clause; zero is a legitimate value and is written.
RequiredSynchronizedSecondariesToCommit int
// Basic creates a Basic availability group (Standard edition): one
// database, two replicas, no readable secondary.
Basic bool
// Contained creates a contained availability group, which carries its own
// master and msdb. SQL Server 2022+.
Contained bool
// Databases are the databases to include. May be empty — a group with no
// databases is legal and is how the "add them afterwards" flow starts.
// Each must already be in full recovery with a full backup taken.
Databases []string
// Replicas are the group's replicas, primary first: CREATE AVAILABILITY
// GROUP makes the instance it runs on the primary, so the first entry has
// to name that instance. At least one is required.
Replicas []AvailabilityReplicaSpec
}
CreateAvailabilityGroupRequest describes an availability group to create.
type CreateDatabaseOptions ¶
type CreateDatabaseOptions struct {
Collation string
RecoveryModel RecoveryModel
CompatLevel CompatibilityLevel
// PrimaryFile and LogFile customize the database's initial data and
// log file (name, path, size, growth, max size) via CREATE DATABASE's
// ON PRIMARY/LOG ON clauses. Leaving either nil lets the server place
// that file at its own default path/size, exactly like CreateDatabase
// with a zero-valued CreateDatabaseOptions always has. FileGroup is
// ignored on both (PrimaryFile is always PRIMARY; LogFile has none) —
// additional filegroups and files are added after creation via
// AddFileGroupContext/AddFileContext, not here.
PrimaryFile *DatabaseFileSpec
LogFile *DatabaseFileSpec
}
CreateDatabaseOptions holds optional parameters for CreateDatabase.
type CreateIndexRequest ¶
type CreateIndexRequest struct {
Name string
Type IndexType
IsUnique bool
KeyColumns []IndexColumnDef
// IncludedColumns are the non-key columns of a nonclustered rowstore
// index (INCLUDE).
IncludedColumns []string
// FilterDefinition is a filtered index's predicate, without the WHERE.
FilterDefinition string
FillFactor int
PadIndex bool
Online bool
SortInTempDB bool
// DropExisting recreates an index of the same name in place
// (DROP_EXISTING = ON) instead of failing on the collision.
DropExisting bool
// DataCompression is the compression keyword — NONE, ROW or PAGE for a
// rowstore index, COLUMNSTORE or COLUMNSTORE_ARCHIVE for a columnstore
// one. Empty leaves it unspecified.
DataCompression string
// CompressionDelay is a columnstore index's COMPRESSION_DELAY, in
// minutes. Zero leaves it unspecified.
CompressionDelay int
// FileGroup is the filegroup the index is created on, and
// PartitionScheme/PartitionColumns the partition scheme it is partitioned
// by. The two are alternatives — an index has one ON clause.
FileGroup string
PartitionScheme string
PartitionColumns []string
// IsPrimaryXML selects the primary XML index form; PrimaryXMLIndex and
// SecondaryXMLType describe a secondary one, which is built over the
// primary index named here.
IsPrimaryXML bool
PrimaryXMLIndex string
SecondaryXMLType XMLSecondaryIndexType
// Tessellation is a spatial index's tessellation scheme (USING).
Tessellation SpatialTessellation
// BoundingBox bounds a geometry index's tessellation. Required for the
// two GEOMETRY_ schemes and rejected for the GEOGRAPHY_ ones, which
// tessellate the whole globe.
BoundingBox *SpatialBoundingBox
// GridLevels is the per-level grid density (GRIDS), which only the two
// non-automatic schemes accept.
GridLevels SpatialGridLevels
// CellsPerObject is the tessellation cell budget per object
// (CELLS_PER_OBJECT), 1-8192. Zero leaves it unspecified.
CellsPerObject int
}
CreateIndexRequest describes a new index to create. Which fields apply depends on Type, and CreateIndex refuses a combination the server would reject rather than emitting DDL that fails at the far end:
- rowstore (CLUSTERED, NONCLUSTERED, and the zero value): key columns, IsUnique, IncludedColumns (nonclustered only), FilterDefinition (nonclustered only), FillFactor/PadIndex, DataCompression NONE/ROW/PAGE.
- COLUMNSTORE: key columns and FilterDefinition (the filtered NCCI form), DataCompression COLUMNSTORE/COLUMNSTORE_ARCHIVE, CompressionDelay.
- CLUSTERED COLUMNSTORE: no key columns at all — the index covers every column of the table.
- XML: one key column (the xml one) plus IsPrimaryXML, or PrimaryXMLIndex and SecondaryXMLType for a secondary index.
- SPATIAL: one key column (the geometry/geography one) plus Tessellation, and BoundingBox for the two GEOMETRY_ schemes.
type CreateJobRequest ¶
type CreateJobRequest struct {
Name string
Description string
// Category defaults to [Uncategorized (Local)] when empty.
Category string
OwnerLogin string
Enabled bool
}
CreateJobRequest describes a new SQL Server Agent job.
type CreateLoginOptions ¶
type CreateLoginOptions struct {
DefaultDatabase string
MustChange bool
// Source selects what the login authenticates from. The zero value
// (LoginSourceAuto) keeps CreateLogin's original behaviour: a SQL login
// when a password is given, a Windows login when it is empty.
Source LoginSource
// CertificateName is the master certificate a LoginSourceCertificate
// login maps to; required for that source and ignored otherwise.
CertificateName string
// AsymmetricKeyName is the master asymmetric key a
// LoginSourceAsymmetricKey login maps to; required for that source and
// ignored otherwise.
AsymmetricKeyName string
}
CreateLoginOptions holds optional parameters for CreateLogin.
type CreateOperatorRequest ¶ added in v0.0.6
CreateOperatorRequest describes a new SQL Server Agent operator.
type CreatePartitionFunctionRequest ¶
type CreatePartitionFunctionRequest struct {
Name string
InputType DataType
IsRight bool
Boundaries []string // literal boundary values, e.g. {"100","200","300"}
}
CreatePartitionFunctionRequest describes a partition function to create.
type CreateScheduleRequest ¶ added in v0.0.6
type CreateScheduleRequest struct {
Name string
Enabled bool
FreqType ScheduleFreqType
FreqInterval int
FreqSubdayType ScheduleSubdayType
FreqSubdayInterval int
FreqRelativeInterval int
FreqRecurrenceFactor int
// ActiveStartDate defaults to today if the zero Time.
ActiveStartDate time.Time
// ActiveEndDate means "no end date" if the zero Time.
ActiveEndDate time.Time
// ActiveStartTime and ActiveEndTime are HHMMSS integers.
ActiveStartTime int
ActiveEndTime int
OwnerLoginName string
}
CreateScheduleRequest describes a new shared schedule.
type CreateSequenceRequest ¶
type CreateSequenceRequest struct {
Schema string
Name string
DataType DataType // defaults to bigint
StartValue int64
Increment int64
MinValue *int64
MaxValue *int64
Cycle bool
Cache *int // nil = no cache; 0 = NO CACHE; >0 = cache size
}
CreateSequenceRequest describes a new sequence.
type CreateStatisticRequest ¶ added in v0.0.10
type CreateStatisticRequest struct {
Name string
Columns []string
// SamplePercent scans that percentage of the rows (SAMPLE n PERCENT).
// Zero lets the server pick its own sample, unless FullScan is set.
SamplePercent int
// FullScan reads every row (WITH FULLSCAN). An alternative to
// SamplePercent, not a companion to it.
FullScan bool
// FilterDefinition is a filtered statistic's predicate, without the
// WHERE.
FilterDefinition string
// NoRecompute stops the server refreshing this statistic automatically
// (WITH NORECOMPUTE) — it then only changes when UPDATE STATISTICS runs.
NoRecompute bool
// Incremental builds the statistic per partition (WITH INCREMENTAL = ON),
// which requires a partitioned table.
Incremental bool
}
CreateStatisticRequest describes a user-defined statistic to create. Columns is ordered: the leading column is the one the histogram is built on, and every column contributes to the density vector.
type CreateTableRequest ¶
type CreateTableRequest struct {
Schema string
Name string
Columns []ColumnDefinition
}
CreateTableRequest describes a table to be created.
type Credential ¶ added in v0.0.4
Credential mirrors a row from sys.credentials — used to populate a Login's "Map to credential" dropdown.
type DataSpace ¶ added in v0.0.10
type DataSpace struct {
Name string
IsPartitionScheme bool
// IsDefaultFileGroup is true for the database's default filegroup, the
// one an object with no ON clause lands on. A scripter uses it to leave
// the clause off where it would say nothing.
IsDefaultFileGroup bool
// PartitionColumn is the column the scheme partitions by; set only when
// IsPartitionScheme.
PartitionColumn string
}
DataSpace names where a table or index keeps its rows — the ON clause of CREATE TABLE and CREATE INDEX. It is either a filegroup or a partition scheme, and for a partition scheme the partitioning column is part of the clause, so it is carried here too: `ON [scheme]([column])`.
Name is empty for an index with no data space of its own in sys.indexes — a memory-optimized table's, whose rows are not on a filegroup at all.
type DataType ¶
type DataType string
DataType mirrors SQL Server column data types.
const ( DataTypeBigInt DataType = "bigint" DataTypeBinary DataType = "binary" DataTypeBit DataType = "bit" DataTypeChar DataType = "char" DataTypeDate DataType = "date" DataTypeDatetime DataType = "datetime" DataTypeDatetime2 DataType = "datetime2" DataTypeDatetimeOffset DataType = "datetimeoffset" DataTypeDecimal DataType = "decimal" DataTypeFloat DataType = "float" DataTypeGeography DataType = "geography" DataTypeGeometry DataType = "geometry" DataTypeHierarchyID DataType = "hierarchyid" DataTypeImage DataType = "image" DataTypeInt DataType = "int" DataTypeMoney DataType = "money" DataTypeNChar DataType = "nchar" DataTypeNText DataType = "ntext" DataTypeNumeric DataType = "numeric" DataTypeNVarChar DataType = "nvarchar" DataTypeReal DataType = "real" DataTypeRowVersion DataType = "rowversion" DataTypeSmallDatetime DataType = "smalldatetime" DataTypeSmallInt DataType = "smallint" DataTypeSmallMoney DataType = "smallmoney" DataTypeSQLVariant DataType = "sql_variant" DataTypeText DataType = "text" DataTypeTime DataType = "time" DataTypeTinyInt DataType = "tinyint" DataTypeUniqueIdentifier DataType = "uniqueidentifier" DataTypeVarBinary DataType = "varbinary" DataTypeVarChar DataType = "varchar" DataTypeXML DataType = "xml" )
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
Database mirrors Microsoft.SqlServer.Management.Smo.Database.
func (*Database) ActualPlan ¶ added in v0.0.4
func (d *Database) ActualPlan(sql string) (*ExecutionPlan, error)
ActualPlan executes sql and captures its actual execution plan (SET STATISTICS XML ON) — SSMS's "Include Actual Execution Plan". Unlike EstimatedPlan, this runs the statement.
func (*Database) ActualPlanContext ¶ added in v0.0.4
ActualPlanContext is the context-aware variant of ActualPlan.
func (*Database) AddExtendedProperty ¶
func (d *Database) AddExtendedProperty(name, value string, level ExtendedPropertyLevel) error
AddExtendedProperty adds a new extended property on an object. Fails if a property with this name already exists at this level — see SetExtendedProperty to update one.
func (*Database) AddExtendedPropertyContext ¶ added in v0.0.4
func (d *Database) AddExtendedPropertyContext(ctx context.Context, name, value string, level ExtendedPropertyLevel) error
AddExtendedPropertyContext is the context-aware variant of AddExtendedProperty.
func (*Database) AddFile ¶ added in v0.0.4
func (d *Database) AddFile(spec DatabaseFileSpec) error
AddFile adds a new data or log file to the database.
func (*Database) AddFileContext ¶ added in v0.0.4
func (d *Database) AddFileContext(ctx context.Context, spec DatabaseFileSpec) error
AddFileContext is the context-aware variant of AddFile.
func (*Database) AddFileGroup ¶ added in v0.0.4
AddFileGroup adds a new (empty) filegroup to the database.
func (*Database) AddFileGroupContext ¶ added in v0.0.4
AddFileGroupContext is the context-aware variant of AddFileGroup.
func (*Database) AddRoleMember ¶
AddRoleMember adds a user to a database role.
func (*Database) AddRoleMemberContext ¶
AddRoleMemberContext is the context-aware variant.
func (*Database) AlterFile ¶ added in v0.0.4
func (d *Database) AlterFile(name string, m FileModify) error
AlterFile changes an existing file's name, size, growth, or max size.
func (*Database) AlterFileContext ¶ added in v0.0.4
AlterFileContext is the context-aware variant of AlterFile.
func (*Database) BulkInsert ¶ added in v0.0.4
BulkInsert streams rows into a table using SQL Server's TDS bulk-copy protocol — the same fast path bcp and SSMS "Import Data" use, far faster than row-by-row INSERTs. It returns the number of rows copied.
rows yields one []any per row, its values ordered to match bc.Columns; a nil element becomes SQL NULL. Yielding a non-nil error aborts the load and that error is returned (wrapped), so a streaming source such as a CSV reader can surface a read failure. Use SliceRows for an in-memory slice.
func (*Database) BulkInsertContext ¶ added in v0.0.4
func (d *Database) BulkInsertContext(ctx context.Context, bc BulkCopy, rows iter.Seq2[[]any, error]) (int64, error)
BulkInsertContext is the context-aware variant of BulkInsert. Cancelling ctx stops the load; the count of rows copied before cancellation is returned alongside the error.
func (*Database) Capabilities ¶ added in v0.0.10
func (d *Database) Capabilities() (*DatabaseCapabilities, error)
Capabilities reports what the connected login may do inside d.
func (*Database) CapabilitiesContext ¶ added in v0.0.10
func (d *Database) CapabilitiesContext(ctx context.Context) (*DatabaseCapabilities, error)
CapabilitiesContext is the context-aware variant of Capabilities.
Accessibility is settled first, at the *server* scope, and an inaccessible database returns early with Accessible false and no error. That ordering is required rather than tidy: the role and permission probe runs inside the database, and Database.query opens with a USE, which is itself what fails for a login that cannot connect there.
func (*Database) Catalog ¶ added in v0.0.5
Catalog returns a bulk snapshot of every user table and view in the database, each with its columns, sorted by schema then name.
func (*Database) CatalogContext ¶ added in v0.0.5
CatalogContext is the context-aware variant of Catalog.
func (*Database) CertificateByName ¶ added in v0.0.9
func (d *Database) CertificateByName(name string) (*Certificate, error)
CertificateByName returns one certificate, or (nil, nil) when the database has none by that name — an absent certificate is the ordinary case for a caller about to create one, not an error.
func (*Database) CertificateByNameContext ¶ added in v0.0.9
CertificateByNameContext is the context-aware variant of CertificateByName.
func (*Database) CertificateSeq ¶ added in v0.0.9
CertificateSeq returns an iterator over all certificates in the database.
func (*Database) Certificates ¶ added in v0.0.9
func (d *Database) Certificates() ([]*Certificate, error)
Certificates returns the database's certificates, excluding the internal ones SQL Server creates for itself (named ##...##).
func (*Database) CertificatesContext ¶ added in v0.0.9
func (d *Database) CertificatesContext(ctx context.Context) ([]*Certificate, error)
CertificatesContext is the context-aware variant of Certificates.
func (*Database) ChangeTracking ¶ added in v0.0.4
func (d *Database) ChangeTracking() (*ChangeTrackingInfo, error)
ChangeTracking returns the database's change tracking settings. Enabled is false (with the rest zero-valued) when change tracking has never been turned on for this database — there's simply no row for it in sys.change_tracking_databases, not an error.
func (*Database) ChangeTrackingContext ¶ added in v0.0.4
func (d *Database) ChangeTrackingContext(ctx context.Context) (*ChangeTrackingInfo, error)
ChangeTrackingContext is the context-aware variant of ChangeTracking.
func (*Database) ClearQueryStore ¶ added in v0.0.5
ClearQueryStore discards all captured Query Store data (SSMS's "Clear Query Store" action) without changing its configuration.
func (*Database) ClearQueryStoreContext ¶ added in v0.0.5
ClearQueryStoreContext is the context-aware variant of ClearQueryStore.
func (*Database) ColumnEncryptionKeyByName ¶ added in v0.0.10
func (d *Database) ColumnEncryptionKeyByName(name string) (*ColumnEncryptionKey, error)
ColumnEncryptionKeyByName returns one column encryption key by name.
func (*Database) ColumnEncryptionKeyByNameContext ¶ added in v0.0.10
func (d *Database) ColumnEncryptionKeyByNameContext(ctx context.Context, name string) (*ColumnEncryptionKey, error)
ColumnEncryptionKeyByNameContext is the context-aware variant of ColumnEncryptionKeyByName.
func (*Database) ColumnEncryptionKeySeq ¶ added in v0.0.5
func (d *Database) ColumnEncryptionKeySeq(ctx context.Context) iter.Seq2[*ColumnEncryptionKey, error]
ColumnEncryptionKeySeq returns an iterator over all column encryption keys in the database.
func (*Database) ColumnEncryptionKeys ¶
func (d *Database) ColumnEncryptionKeys() ([]*ColumnEncryptionKey, error)
ColumnEncryptionKeys returns all column encryption keys in the database.
func (*Database) ColumnEncryptionKeysContext ¶ added in v0.0.5
func (d *Database) ColumnEncryptionKeysContext(ctx context.Context) ([]*ColumnEncryptionKey, error)
ColumnEncryptionKeysContext is the context-aware variant of ColumnEncryptionKeys.
func (*Database) ColumnMasterKeyByName ¶ added in v0.0.10
func (d *Database) ColumnMasterKeyByName(name string) (*ColumnMasterKey, error)
ColumnMasterKeyByName returns one column master key by name.
func (*Database) ColumnMasterKeyByNameContext ¶ added in v0.0.10
func (d *Database) ColumnMasterKeyByNameContext(ctx context.Context, name string) (*ColumnMasterKey, error)
ColumnMasterKeyByNameContext is the context-aware variant of ColumnMasterKeyByName.
func (*Database) ColumnMasterKeySeq ¶ added in v0.0.5
ColumnMasterKeySeq returns an iterator over all column master keys in the database.
func (*Database) ColumnMasterKeys ¶
func (d *Database) ColumnMasterKeys() ([]*ColumnMasterKey, error)
ColumnMasterKeys returns all column master keys in the database.
func (*Database) ColumnMasterKeysContext ¶ added in v0.0.5
func (d *Database) ColumnMasterKeysContext(ctx context.Context) ([]*ColumnMasterKey, error)
ColumnMasterKeysContext is the context-aware variant of ColumnMasterKeys.
func (*Database) ColumnPermissionSeq ¶ added in v0.0.8
func (d *Database) ColumnPermissionSeq(ctx context.Context, schema, name string) iter.Seq2[*ColumnPermissionEntry, error]
ColumnPermissionSeq returns an iterator over every column-level GRANT/DENY entry recorded on schema.name.
func (*Database) ColumnPermissions ¶ added in v0.0.8
func (d *Database) ColumnPermissions(schema, name string) ([]*ColumnPermissionEntry, error)
ColumnPermissions returns every column-level GRANT/DENY entry recorded on schema.name, for all principals and all columns.
func (*Database) ColumnPermissionsContext ¶ added in v0.0.8
func (d *Database) ColumnPermissionsContext(ctx context.Context, schema, name string) ([]*ColumnPermissionEntry, error)
ColumnPermissionsContext is the context-aware variant of ColumnPermissions.
func (*Database) ColumnPermissionsForPrincipal ¶ added in v0.0.8
func (d *Database) ColumnPermissionsForPrincipal(principal string) ([]*ColumnPermissionEntry, error)
ColumnPermissionsForPrincipal returns every column-level GRANT/DENY entry principal holds anywhere in the database — the column-level counterpart of PermissionsForPrincipal, which reports object-, schema- and database-scoped entries and deliberately leaves column entries out (a Securables page lists securables, and a column is not one of them; SSMS puts them behind a per-securable "Column Permissions..." button).
func (*Database) ColumnPermissionsForPrincipalContext ¶ added in v0.0.8
func (d *Database) ColumnPermissionsForPrincipalContext(ctx context.Context, principal string) ([]*ColumnPermissionEntry, error)
ColumnPermissionsForPrincipalContext is the context-aware variant of ColumnPermissionsForPrincipal.
func (*Database) ColumnPermissionsForPrincipalSeq ¶ added in v0.0.8
func (d *Database) ColumnPermissionsForPrincipalSeq(ctx context.Context, principal string) iter.Seq2[*ColumnPermissionEntry, error]
ColumnPermissionsForPrincipalSeq returns an iterator over every column-level GRANT/DENY entry principal holds anywhere in the database.
func (*Database) CompatibilityLevel ¶
func (d *Database) CompatibilityLevel() CompatibilityLevel
CompatibilityLevel returns the database compatibility level.
func (*Database) CreateCertificate ¶ added in v0.0.9
func (d *Database) CreateCertificate(spec CertificateSpec) error
CreateCertificate creates a certificate in the database.
func (*Database) CreateCertificateContext ¶ added in v0.0.9
func (d *Database) CreateCertificateContext(ctx context.Context, spec CertificateSpec) error
CreateCertificateContext is the context-aware variant of CreateCertificate.
func (*Database) CreateColumnEncryptionKey ¶ added in v0.0.10
func (d *Database) CreateColumnEncryptionKey(name string, values []ColumnEncryptionKeyValue) error
CreateColumnEncryptionKey creates a column encryption key from one or more already-encrypted values.
Each value's key material is the CEK encrypted under a column master key, which is done client-side by whatever can reach that master key's private key (SSMS and the SqlColumnEncryptionKey PowerShell cmdlets both do) — nothing here can generate or verify it, and the server rejects a value it cannot decrypt on first use. Pass two values only to reproduce a key mid-rotation; one is the ordinary case.
func (*Database) CreateColumnEncryptionKeyContext ¶ added in v0.0.10
func (d *Database) CreateColumnEncryptionKeyContext(ctx context.Context, name string, values []ColumnEncryptionKeyValue) error
CreateColumnEncryptionKeyContext is the context-aware variant of CreateColumnEncryptionKey. The statement is written the way the scripter writes it (buildColumnEncryptionKeyScript), so a key created here and one scripted from the server read back the same.
func (*Database) CreateColumnMasterKey ¶
func (d *Database) CreateColumnMasterKey(name, keyStoreProvider, keyPath string, enclaveComputations bool) error
CreateColumnMasterKey creates a column master key metadata entry. Note: the actual key must already exist in the key store.
enclaveComputations can only be false here. The ENCLAVE_COMPUTATIONS clause takes a signature over the key's metadata — CREATE COLUMN MASTER KEY spells it ENCLAVE_COMPUTATIONS (SIGNATURE = 0x...) and has no boolean form — and that signature is computed by the client from the master key's private key, so nothing here can supply it. Passing true returns an error naming CreateColumnMasterKeyWithSignature rather than emitting a statement the server will reject.
func (*Database) CreateColumnMasterKeyContext ¶ added in v0.0.5
func (d *Database) CreateColumnMasterKeyContext(ctx context.Context, name, keyStoreProvider, keyPath string, enclaveComputations bool) error
CreateColumnMasterKeyContext is the context-aware variant of CreateColumnMasterKey.
func (*Database) CreateColumnMasterKeyWithSignature ¶ added in v0.0.10
func (d *Database) CreateColumnMasterKeyWithSignature(name, keyStoreProvider, keyPath string, signature []byte) error
CreateColumnMasterKeyWithSignature creates a column master key that allows enclave computations. signature is the digital signature over the key's metadata, the same value ColumnMasterKey.Signature reads back and the scripter writes out verbatim; it is produced client-side by whatever holds the master key's private key (SSMS and the SqlColumnMasterKey PowerShell cmdlets both do), and the server verifies it against the rest of the metadata, so an empty or wrong one is rejected. Use CreateColumnMasterKey for a key that does not allow enclave computations.
func (*Database) CreateColumnMasterKeyWithSignatureContext ¶ added in v0.0.10
func (d *Database) CreateColumnMasterKeyWithSignatureContext(ctx context.Context, name, keyStoreProvider, keyPath string, signature []byte) error
CreateColumnMasterKeyWithSignatureContext is the context-aware variant of CreateColumnMasterKeyWithSignature.
func (*Database) CreateDate ¶
CreateDate returns the date the database was created.
func (*Database) CreateMasterKey ¶ added in v0.0.9
CreateMasterKey creates the database master key, protected by password.
The key is also encrypted by the service master key automatically, which is what lets SQL Server open it without the password at startup. Losing that — a restore onto another instance, or a service master key that no longer decrypts — leaves the password as the only way in, so it is worth keeping.
func (*Database) CreateMasterKeyContext ¶ added in v0.0.9
CreateMasterKeyContext is the context-aware variant of CreateMasterKey.
func (*Database) CreatePartitionFunction ¶
func (d *Database) CreatePartitionFunction(req CreatePartitionFunctionRequest) error
CreatePartitionFunction creates a partition function.
func (*Database) CreatePartitionFunctionContext ¶ added in v0.0.5
func (d *Database) CreatePartitionFunctionContext(ctx context.Context, req CreatePartitionFunctionRequest) error
CreatePartitionFunctionContext is the context-aware variant of CreatePartitionFunction.
func (*Database) CreatePartitionScheme ¶
CreatePartitionScheme creates a partition scheme backed by a partition function.
func (*Database) CreatePartitionSchemeContext ¶ added in v0.0.5
func (d *Database) CreatePartitionSchemeContext(ctx context.Context, name, functionName string, fileGroups []string) error
CreatePartitionSchemeContext is the context-aware variant of CreatePartitionScheme.
func (*Database) CreateSchema ¶
CreateSchema creates a new schema in the database.
func (*Database) CreateSchemaContext ¶
CreateSchemaContext is the context-aware variant of CreateSchema.
func (*Database) CreateSequence ¶
func (d *Database) CreateSequence(req CreateSequenceRequest) error
CreateSequence creates a new sequence in the database.
func (*Database) CreateSequenceContext ¶ added in v0.0.5
func (d *Database) CreateSequenceContext(ctx context.Context, req CreateSequenceRequest) error
CreateSequenceContext is the context-aware variant of CreateSequence.
func (*Database) CreateStoredProcedure ¶
CreateStoredProcedure creates (or replaces) a stored procedure. schema may be empty (defaults to dbo). body is the raw T-SQL after AS.
func (*Database) CreateStoredProcedureContext ¶
func (d *Database) CreateStoredProcedureContext(ctx context.Context, schema, name, body string) error
CreateStoredProcedureContext is the context-aware variant.
func (*Database) CreateSynonym ¶
CreateSynonym creates a synonym for a base object. baseObject should be the fully qualified name, e.g. "[OtherDB].[dbo].[MyTable]".
func (*Database) CreateSynonymContext ¶ added in v0.0.5
CreateSynonymContext is the context-aware variant of CreateSynonym.
func (*Database) CreateTable ¶
func (d *Database) CreateTable(req CreateTableRequest) error
CreateTable creates a table from a CreateTableRequest.
func (*Database) CreateTableContext ¶
func (d *Database) CreateTableContext(ctx context.Context, req CreateTableRequest) error
CreateTableContext is the context-aware variant of CreateTable.
func (*Database) CreateUser ¶
CreateUser creates a database user mapped to a login.
func (*Database) CreateUserContext ¶
func (d *Database) CreateUserContext(ctx context.Context, userName, loginName, defaultSchema string) error
CreateUserContext is the context-aware variant of CreateUser.
func (*Database) DatabaseExtendedProperties ¶
func (d *Database) DatabaseExtendedProperties() ([]*ExtendedProperty, error)
DatabaseExtendedProperties returns all extended properties at database level.
func (*Database) DatabaseExtendedPropertiesContext ¶ added in v0.0.5
func (d *Database) DatabaseExtendedPropertiesContext(ctx context.Context) ([]*ExtendedProperty, error)
DatabaseExtendedPropertiesContext is the context-aware variant of DatabaseExtendedProperties.
func (*Database) DatabaseExtendedPropertySeq ¶ added in v0.0.5
func (d *Database) DatabaseExtendedPropertySeq(ctx context.Context) iter.Seq2[*ExtendedProperty, error]
DatabaseExtendedPropertySeq returns an iterator over all extended properties at database level.
func (*Database) DatabasePermissionSeq ¶ added in v0.0.4
func (d *Database) DatabasePermissionSeq(ctx context.Context) iter.Seq2[*DatabasePermissionEntry, error]
DatabasePermissionSeq returns an iterator over all database-scoped GRANT/DENY entries.
func (*Database) DatabasePermissions ¶ added in v0.0.4
func (d *Database) DatabasePermissions() ([]*DatabasePermissionEntry, error)
DatabasePermissions returns every database-scoped GRANT/DENY entry — permissions granted on the database itself, not on a specific object within it (see Permissions for that).
func (*Database) DatabasePermissionsContext ¶ added in v0.0.4
func (d *Database) DatabasePermissionsContext(ctx context.Context) ([]*DatabasePermissionEntry, error)
DatabasePermissionsContext is the context-aware variant of DatabasePermissions.
func (*Database) DatabaseRoleSeq ¶ added in v0.0.6
DatabaseRoleSeq returns an iterator over all database-level roles.
func (*Database) DatabaseRoles ¶
func (d *Database) DatabaseRoles() ([]*DatabaseRole, error)
DatabaseRoles returns all roles defined in the database.
func (*Database) DatabaseRolesContext ¶
func (d *Database) DatabaseRolesContext(ctx context.Context) ([]*DatabaseRole, error)
DatabaseRolesContext is the context-aware variant of DatabaseRoles.
func (*Database) DatabaseScopedConfigSeq ¶ added in v0.0.6
func (d *Database) DatabaseScopedConfigSeq(ctx context.Context) iter.Seq2[*DatabaseScopedConfig, error]
DatabaseScopedConfigSeq returns an iterator over all database-scoped configuration options.
func (*Database) DatabaseScopedConfigs ¶ added in v0.0.5
func (d *Database) DatabaseScopedConfigs() ([]*DatabaseScopedConfig, error)
DatabaseScopedConfigs returns every database scoped configuration option.
func (*Database) DatabaseScopedConfigsContext ¶ added in v0.0.5
func (d *Database) DatabaseScopedConfigsContext(ctx context.Context) ([]*DatabaseScopedConfig, error)
DatabaseScopedConfigsContext is the context-aware variant of DatabaseScopedConfigs.
func (*Database) DenyColumnPermission ¶ added in v0.0.8
func (d *Database) DenyColumnPermission(schema, name string, permission ObjectPermission, columns []string, principal string) error
DenyColumnPermission denies permission on the named columns of schema.name to principal.
func (*Database) DenyColumnPermissionContext ¶ added in v0.0.8
func (d *Database) DenyColumnPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, columns []string, principal string) error
DenyColumnPermissionContext is the context-aware variant of DenyColumnPermission.
func (*Database) DenyColumnPermissionWithOptions ¶ added in v0.0.8
func (d *Database) DenyColumnPermissionWithOptions(schema, name string, permission ObjectPermission, columns []string, principal string, opts PermissionOptions) error
DenyColumnPermissionWithOptions denies a column-level permission honouring opts — the CASCADE form of DenyColumnPermission.
func (*Database) DenyColumnPermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) DenyColumnPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, columns []string, principal string, opts PermissionOptions) error
DenyColumnPermissionWithOptionsContext is the context-aware variant of DenyColumnPermissionWithOptions.
func (*Database) DenyDatabasePermission ¶ added in v0.0.4
DenyDatabasePermission denies a database-level permission to principal.
func (*Database) DenyDatabasePermissionContext ¶ added in v0.0.4
func (d *Database) DenyDatabasePermissionContext(ctx context.Context, permission, principal string) error
DenyDatabasePermissionContext is the context-aware variant of DenyDatabasePermission.
func (*Database) DenyDatabasePermissionWithOptions ¶ added in v0.0.8
func (d *Database) DenyDatabasePermissionWithOptions(permission, principal string, opts PermissionOptions) error
DenyDatabasePermissionWithOptions denies a database-level permission to principal, honouring opts.
func (*Database) DenyDatabasePermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) DenyDatabasePermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
DenyDatabasePermissionWithOptionsContext is the context-aware variant of DenyDatabasePermissionWithOptions.
func (*Database) DenyPermission ¶ added in v0.0.4
func (d *Database) DenyPermission(schema, name string, permission ObjectPermission, principal string) error
DenyPermission denies permission on schema.name to principal.
func (*Database) DenyPermissionContext ¶ added in v0.0.4
func (d *Database) DenyPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, principal string) error
DenyPermissionContext is the context-aware variant of DenyPermission.
func (*Database) DenyPermissionWithOptions ¶ added in v0.0.8
func (d *Database) DenyPermissionWithOptions(schema, name string, permission ObjectPermission, principal string, opts PermissionOptions) error
DenyPermissionWithOptions denies permission on schema.name to principal, honouring opts — the CASCADE form of DenyPermission.
func (*Database) DenyPermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) DenyPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, principal string, opts PermissionOptions) error
DenyPermissionWithOptionsContext is the context-aware variant of DenyPermissionWithOptions.
func (*Database) DenySchemaPermission ¶ added in v0.0.5
func (d *Database) DenySchemaPermission(schemaName string, permission ObjectPermission, principal string) error
DenySchemaPermission denies permission on a schema to principal.
func (*Database) DenySchemaPermissionContext ¶ added in v0.0.5
func (d *Database) DenySchemaPermissionContext(ctx context.Context, schemaName string, permission ObjectPermission, principal string) error
DenySchemaPermissionContext is the context-aware variant of DenySchemaPermission.
func (*Database) DenySchemaPermissionWithOptions ¶ added in v0.0.8
func (d *Database) DenySchemaPermissionWithOptions(schemaName string, permission ObjectPermission, principal string, opts PermissionOptions) error
DenySchemaPermissionWithOptions denies permission on a schema to principal, honouring opts.
func (*Database) DenySchemaPermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) DenySchemaPermissionWithOptionsContext(ctx context.Context, schemaName string, permission ObjectPermission, principal string, opts PermissionOptions) error
DenySchemaPermissionWithOptionsContext is the context-aware variant of DenySchemaPermissionWithOptions.
func (*Database) Dependencies ¶ added in v0.0.4
func (d *Database) Dependencies(schema, name string) ([]*Dependency, error)
Dependencies returns the objects that schema.name's own definition references — SSMS's "Object Dependencies > Objects on which ... depends".
func (*Database) DependenciesContext ¶ added in v0.0.4
func (d *Database) DependenciesContext(ctx context.Context, schema, name string) ([]*Dependency, error)
DependenciesContext is the context-aware variant of Dependencies.
func (*Database) DependencySeq ¶ added in v0.0.6
func (d *Database) DependencySeq(ctx context.Context, schema, name string) iter.Seq2[*Dependency, error]
DependencySeq returns an iterator over the objects schema.name's own definition references.
func (*Database) DependentSeq ¶ added in v0.0.6
func (d *Database) DependentSeq(ctx context.Context, schema, name string) iter.Seq2[*Dependency, error]
DependentSeq returns an iterator over the objects whose own definition references schema.name.
func (*Database) Dependents ¶ added in v0.0.4
func (d *Database) Dependents(schema, name string) ([]*Dependency, error)
Dependents returns the objects whose own definition references schema.name — SSMS's "Object Dependencies > Objects that depend on ...".
func (*Database) DependentsContext ¶ added in v0.0.4
func (d *Database) DependentsContext(ctx context.Context, schema, name string) ([]*Dependency, error)
DependentsContext is the context-aware variant of Dependents.
func (*Database) DropDatabaseRole ¶ added in v0.0.9
DropDatabaseRole drops a database role. A role that still owns a schema or has members is refused by the server, not here.
func (*Database) DropDatabaseRoleContext ¶ added in v0.0.9
DropDatabaseRoleContext is the context-aware variant of DropDatabaseRole.
func (*Database) DropExtendedProperty ¶
func (d *Database) DropExtendedProperty(name string, level ExtendedPropertyLevel) error
DropExtendedProperty drops an extended property from an object.
func (*Database) DropExtendedPropertyContext ¶ added in v0.0.4
func (d *Database) DropExtendedPropertyContext(ctx context.Context, name string, level ExtendedPropertyLevel) error
DropExtendedPropertyContext is the context-aware variant of DropExtendedProperty.
func (*Database) DropFunction ¶ added in v0.0.9
DropFunction drops a user-defined function — scalar, inline table-valued, or multi-statement table-valued alike, all of which DROP FUNCTION removes. A function that isn't there is the server's error, not a silent success — see the note on Database.DropTable.
func (*Database) DropFunctionContext ¶ added in v0.0.9
DropFunctionContext is the context-aware variant of DropFunction.
func (*Database) DropSchema ¶
DropSchema drops a schema from the database.
func (*Database) DropSchemaContext ¶
DropSchemaContext is the context-aware variant of DropSchema.
func (*Database) DropSequence ¶ added in v0.0.9
DropSequence drops a sequence by name — the form for a caller that has the name but not the object, as Sequences() would have to be listed first to get one.
func (*Database) DropSequenceContext ¶ added in v0.0.9
DropSequenceContext is the context-aware variant of DropSequence.
func (*Database) DropStoredProcedure ¶
DropStoredProcedure drops a stored procedure. A procedure that isn't there is the server's error, not a silent success — see the note on Database.DropTable.
func (*Database) DropStoredProcedureContext ¶
DropStoredProcedureContext is the context-aware variant.
func (*Database) DropSynonym ¶ added in v0.0.9
DropSynonym drops a synonym by name — the form for a caller that has the name but not the object, as Synonyms() would have to be listed first to get one. A synonym that isn't there is the server's error, not a silent success — see the note on Database.DropTable.
func (*Database) DropSynonymContext ¶ added in v0.0.9
DropSynonymContext is the context-aware variant of DropSynonym.
func (*Database) DropTable ¶
DropTable drops a table. When cascade=true it first drops all incoming foreign-key constraints.
Dropping something that isn't there is an error ¶
This and every other Drop* write method issue a bare DROP, so a name that matches nothing comes back as the server's "Cannot drop ... because it does not exist" rather than as success. Half of them used to carry IF EXISTS and half did not, which made the same gesture in a caller's UI report two different things about the same situation: a deleted view that was already gone said "deleted", a deleted sequence said the server refused. Callers that want the idempotent form should ignore the error, which is a decision they can make and this package cannot make for them.
The generated *scripts* keep IF EXISTS — Scripter's DROP-and-CREATE output exists to be re-run, which is the opposite requirement.
func (*Database) DropTableContext ¶
DropTableContext is the context-aware variant of DropTable.
func (*Database) DropTrigger ¶ added in v0.0.9
DropTrigger drops a DML trigger. schema is the trigger's own schema — the schema of the table it is defined on. A trigger that isn't there is the server's error, not a silent success — see the note on Database.DropTable.
func (*Database) DropTriggerContext ¶ added in v0.0.9
DropTriggerContext is the context-aware variant of DropTrigger.
func (*Database) DropUserContext ¶
DropUserContext is the context-aware variant of DropUser.
func (*Database) DropView ¶ added in v0.0.9
DropView drops a view. A view that isn't there is the server's error, not a silent success — see the note on Database.DropTable.
func (*Database) DropViewContext ¶ added in v0.0.9
DropViewContext is the context-aware variant of DropView.
func (*Database) EffectiveObjectPermissionSeq ¶ added in v0.0.8
func (d *Database) EffectiveObjectPermissionSeq(ctx context.Context, schema, name, principal string) iter.Seq2[*EffectivePermission, error]
EffectiveObjectPermissionSeq returns an iterator over every permission principal effectively holds on the table or view schema.name.
func (*Database) EffectiveObjectPermissions ¶ added in v0.0.8
func (d *Database) EffectiveObjectPermissions(schema, name, principal string) ([]*EffectivePermission, error)
EffectiveObjectPermissions returns every permission principal effectively holds on the table or view schema.name, column-level entries included (see EffectivePermission.Subentity). principal must be a database user — see EffectivePermissions for why a role cannot be one.
func (*Database) EffectiveObjectPermissionsContext ¶ added in v0.0.8
func (d *Database) EffectiveObjectPermissionsContext(ctx context.Context, schema, name, principal string) ([]*EffectivePermission, error)
EffectiveObjectPermissionsContext is the context-aware variant of EffectiveObjectPermissions.
func (*Database) EffectivePermissionSeq ¶ added in v0.0.8
func (d *Database) EffectivePermissionSeq(ctx context.Context, principal string) iter.Seq2[*EffectivePermission, error]
EffectivePermissionSeq returns an iterator over every permission principal effectively holds on the database itself.
func (*Database) EffectivePermissions ¶ added in v0.0.8
func (d *Database) EffectivePermissions(principal string) ([]*EffectivePermission, error)
EffectivePermissions returns every permission principal effectively holds on the database itself — SSMS's Effective tab on a database user's Securables page, with the database row selected.
principal must be a database *user* that exists in this database. A database role is not accepted and cannot be made to work: every function here resolves permissions by impersonating the principal, and SQL Server refuses to impersonate a role — "Cannot execute as the database principal because the principal %q does not exist, this type of principal cannot be impersonated, or you do not have permission" (Msg 15517), verified live 2026-08-05 against a role that plainly did exist. There is no principal argument to fn_my_permissions to use instead; it always answers for the current execution context.
func (*Database) EffectivePermissionsContext ¶ added in v0.0.8
func (d *Database) EffectivePermissionsContext(ctx context.Context, principal string) ([]*EffectivePermission, error)
EffectivePermissionsContext is the context-aware variant of EffectivePermissions.
func (*Database) EffectiveSchemaPermissionSeq ¶ added in v0.0.8
func (d *Database) EffectiveSchemaPermissionSeq(ctx context.Context, schemaName, principal string) iter.Seq2[*EffectivePermission, error]
EffectiveSchemaPermissionSeq returns an iterator over every permission principal effectively holds on a schema.
func (*Database) EffectiveSchemaPermissions ¶ added in v0.0.8
func (d *Database) EffectiveSchemaPermissions(schemaName, principal string) ([]*EffectivePermission, error)
EffectiveSchemaPermissions returns every permission principal effectively holds on a schema. principal must be a database user — see EffectivePermissions for why a role cannot be one.
func (*Database) EffectiveSchemaPermissionsContext ¶ added in v0.0.8
func (d *Database) EffectiveSchemaPermissionsContext(ctx context.Context, schemaName, principal string) ([]*EffectivePermission, error)
EffectiveSchemaPermissionsContext is the context-aware variant of EffectiveSchemaPermissions.
func (*Database) EstimatedPlan ¶ added in v0.0.4
func (d *Database) EstimatedPlan(sql string) (*ExecutionPlan, error)
EstimatedPlan captures sql's estimated execution plan without running it (SET SHOWPLAN_XML ON) — SSMS's "Display Estimated Execution Plan".
func (*Database) EstimatedPlanContext ¶ added in v0.0.4
func (d *Database) EstimatedPlanContext(ctx context.Context, sqlText string) (*ExecutionPlan, error)
EstimatedPlanContext is the context-aware variant of EstimatedPlan.
func (*Database) ExecProc ¶ added in v0.0.4
func (d *Database) ExecProc(schema, name string, params ...ProcParam) (ProcResult, error)
ExecProc executes a stored procedure by schema and name, binding the given parameters and capturing its return status. Output parameter values are written to the pointers passed to Out / InOut. Any result sets the procedure emits are discarded; use the query methods when you need the rows.
func (*Database) ExecProcContext ¶ added in v0.0.4
func (d *Database) ExecProcContext(ctx context.Context, schema, name string, params ...ProcParam) (ProcResult, error)
ExecProcContext is the context-aware variant of ExecProc.
func (*Database) ExtendedProperties ¶
func (d *Database) ExtendedProperties(level ExtendedPropertyLevel) ([]*ExtendedProperty, error)
ExtendedProperties returns the extended properties for a specific object.
func (*Database) ExtendedPropertiesContext ¶ added in v0.0.5
func (d *Database) ExtendedPropertiesContext(ctx context.Context, level ExtendedPropertyLevel) ([]*ExtendedProperty, error)
ExtendedPropertiesContext is the context-aware variant of ExtendedProperties.
func (*Database) ExtendedPropertySeq ¶ added in v0.0.6
func (d *Database) ExtendedPropertySeq(ctx context.Context, level ExtendedPropertyLevel) iter.Seq2[*ExtendedProperty, error]
ExtendedPropertySeq returns an iterator over the extended properties at the given level (as opposed to DatabaseExtendedPropertySeq's database-level-only shortcut).
func (*Database) FileGroupSeq ¶ added in v0.0.6
FileGroupSeq returns an iterator over all filegroups in the database.
func (*Database) FileGroups ¶
FileGroups returns all filegroups and their files.
func (*Database) FileGroupsContext ¶
FileGroupsContext is the context-aware variant of FileGroups.
func (*Database) FileSeq ¶ added in v0.0.4
FileSeq returns an iterator over every file in the database.
func (*Database) Files ¶ added in v0.0.4
func (d *Database) Files() ([]*DatabaseFileInfo, error)
Files returns every file in the database, data and log alike.
func (*Database) FilesContext ¶ added in v0.0.4
func (d *Database) FilesContext(ctx context.Context) ([]*DatabaseFileInfo, error)
FilesContext is the context-aware variant of Files.
func (*Database) FindSecurables ¶ added in v0.0.8
func (d *Database) FindSecurables(search SecurableSearch) ([]SecurableRef, error)
FindSecurables returns the schemas, tables and views matching search.
func (*Database) FindSecurablesContext ¶ added in v0.0.8
func (d *Database) FindSecurablesContext(ctx context.Context, search SecurableSearch) ([]SecurableRef, error)
FindSecurablesContext is the context-aware variant of FindSecurables.
One query over sys.schemas, sys.tables and sys.views, for a caller that needs candidates matching what the user typed rather than the whole catalog — a database with thousands of tables makes "list everything and filter in the client" both slow to open and useless as a picker.
func (*Database) FlushQueryStore ¶ added in v0.0.5
FlushQueryStore forces Query Store to persist its in-memory data to disk immediately (SSMS's "Flush Data" action), via sys.sp_query_store_flush_db.
func (*Database) FlushQueryStoreContext ¶ added in v0.0.5
FlushQueryStoreContext is the context-aware variant of FlushQueryStore.
func (*Database) GrantColumnPermission ¶ added in v0.0.8
func (d *Database) GrantColumnPermission(schema, name string, permission ObjectPermission, columns []string, principal string) error
GrantColumnPermission grants permission on the named columns of schema.name to principal. Passing several columns renders the one statement SQL Server accepts for them — GRANT SELECT (a, b) ON ... — not one statement per column.
func (*Database) GrantColumnPermissionContext ¶ added in v0.0.8
func (d *Database) GrantColumnPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, columns []string, principal string) error
GrantColumnPermissionContext is the context-aware variant of GrantColumnPermission.
func (*Database) GrantColumnPermissionWithOptions ¶ added in v0.0.8
func (d *Database) GrantColumnPermissionWithOptions(schema, name string, permission ObjectPermission, columns []string, principal string, opts PermissionOptions) error
GrantColumnPermissionWithOptions grants a column-level permission honouring opts — the WITH GRANT OPTION form of GrantColumnPermission.
func (*Database) GrantColumnPermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) GrantColumnPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, columns []string, principal string, opts PermissionOptions) error
GrantColumnPermissionWithOptionsContext is the context-aware variant of GrantColumnPermissionWithOptions.
func (*Database) GrantDatabasePermission ¶ added in v0.0.4
GrantDatabasePermission grants a database-level permission to principal.
func (*Database) GrantDatabasePermissionContext ¶ added in v0.0.4
func (d *Database) GrantDatabasePermissionContext(ctx context.Context, permission, principal string) error
GrantDatabasePermissionContext is the context-aware variant of GrantDatabasePermission.
func (*Database) GrantDatabasePermissionWithOptions ¶ added in v0.0.8
func (d *Database) GrantDatabasePermissionWithOptions(permission, principal string, opts PermissionOptions) error
GrantDatabasePermissionWithOptions grants a database-level permission to principal, honouring opts.
func (*Database) GrantDatabasePermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) GrantDatabasePermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
GrantDatabasePermissionWithOptionsContext is the context-aware variant of GrantDatabasePermissionWithOptions.
func (*Database) GrantPermission ¶ added in v0.0.4
func (d *Database) GrantPermission(schema, name string, permission ObjectPermission, principal string) error
GrantPermission grants permission on schema.name to principal.
func (*Database) GrantPermissionContext ¶ added in v0.0.4
func (d *Database) GrantPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, principal string) error
GrantPermissionContext is the context-aware variant of GrantPermission.
func (*Database) GrantPermissionWithOptions ¶ added in v0.0.8
func (d *Database) GrantPermissionWithOptions(schema, name string, permission ObjectPermission, principal string, opts PermissionOptions) error
GrantPermissionWithOptions grants permission on schema.name to principal, honouring opts — the WITH GRANT OPTION form of GrantPermission.
func (*Database) GrantPermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) GrantPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, principal string, opts PermissionOptions) error
GrantPermissionWithOptionsContext is the context-aware variant of GrantPermissionWithOptions.
func (*Database) GrantSchemaPermission ¶ added in v0.0.5
func (d *Database) GrantSchemaPermission(schemaName string, permission ObjectPermission, principal string) error
GrantSchemaPermission grants permission on a schema to principal.
func (*Database) GrantSchemaPermissionContext ¶ added in v0.0.5
func (d *Database) GrantSchemaPermissionContext(ctx context.Context, schemaName string, permission ObjectPermission, principal string) error
GrantSchemaPermissionContext is the context-aware variant of GrantSchemaPermission.
func (*Database) GrantSchemaPermissionWithOptions ¶ added in v0.0.8
func (d *Database) GrantSchemaPermissionWithOptions(schemaName string, permission ObjectPermission, principal string, opts PermissionOptions) error
GrantSchemaPermissionWithOptions grants permission on a schema to principal, honouring opts.
func (*Database) GrantSchemaPermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) GrantSchemaPermissionWithOptionsContext(ctx context.Context, schemaName string, permission ObjectPermission, principal string, opts PermissionOptions) error
GrantSchemaPermissionWithOptionsContext is the context-aware variant of GrantSchemaPermissionWithOptions.
func (*Database) HasMasterKey ¶ added in v0.0.9
HasMasterKey reports whether the database has a master key. A certificate whose private key is to open without a password needs one.
func (*Database) HasMasterKeyContext ¶ added in v0.0.9
HasMasterKeyContext is the context-aware variant of HasMasterKey.
func (*Database) IsReadOnly ¶
IsReadOnly reports whether the database is set to read-only.
func (*Database) IsSystem ¶ added in v0.0.4
IsSystem reports whether this is one of SQL Server's four built-in system databases (master, tempdb, model, msdb), identified by their permanently reserved database_id (1-4) rather than by name.
func (*Database) ObjectColumnSeq ¶ added in v0.0.8
func (d *Database) ObjectColumnSeq(ctx context.Context, schema, name string) iter.Seq2[*Column, error]
ObjectColumnSeq returns an iterator over the columns of the table or view schema.name — the Database-scoped counterpart of Table.ColumnSeq, and the only one of the two that reaches a view.
func (*Database) ObjectColumns ¶ added in v0.0.8
ObjectColumns returns the columns of the table or view schema.name, in ordinal order. Table.Columns covers tables only, and a view has no handle type of its own that carries an object_id, so this is the way to reach a view's columns — which do carry permissions, and so do turn up on a Securables page.
func (*Database) ObjectColumnsContext ¶ added in v0.0.8
func (d *Database) ObjectColumnsContext(ctx context.Context, schema, name string) ([]*Column, error)
ObjectColumnsContext is the context-aware variant of ObjectColumns.
The columns a view does not have — identity, computed text, defaults, primary key — come back at their zero values, because the joins that supply them simply do not match for a view. Name, ordinal, type, length/precision/scale, nullability and collation are all real.
func (*Database) Options ¶ added in v0.0.4
func (d *Database) Options() (*DatabaseOptions, error)
Options returns the database's ALTER DATABASE SET options.
func (*Database) OptionsContext ¶ added in v0.0.4
func (d *Database) OptionsContext(ctx context.Context) (*DatabaseOptions, error)
OptionsContext is the context-aware variant of Options. Queried against sys.databases at server scope (like Server.DatabaseByNameContext), not through d.query — these are catalog-view columns, not per-database data.
func (*Database) ParameterSeq ¶ added in v0.0.10
func (d *Database) ParameterSeq(ctx context.Context, schema, name string) iter.Seq2[*Parameter, error]
ParameterSeq returns an iterator over the parameters of one stored procedure or function.
func (*Database) Parameters ¶ added in v0.0.10
Parameters returns the parameters of one stored procedure or function, in declaration order.
func (*Database) ParametersContext ¶ added in v0.0.10
func (d *Database) ParametersContext(ctx context.Context, schema, name string) ([]*Parameter, error)
ParametersContext is the context-aware variant of Parameters.
func (*Database) PartitionFunctionByName ¶ added in v0.0.10
func (d *Database) PartitionFunctionByName(name string) (*PartitionFunction, error)
PartitionFunctionByName returns one partition function by name.
func (*Database) PartitionFunctionByNameContext ¶ added in v0.0.10
func (d *Database) PartitionFunctionByNameContext(ctx context.Context, name string) (*PartitionFunction, error)
PartitionFunctionByNameContext is the context-aware variant of PartitionFunctionByName.
func (*Database) PartitionFunctionSeq ¶ added in v0.0.5
PartitionFunctionSeq returns an iterator over all partition functions in the database.
func (*Database) PartitionFunctions ¶
func (d *Database) PartitionFunctions() ([]*PartitionFunction, error)
PartitionFunctions returns all partition functions in the database.
func (*Database) PartitionFunctionsContext ¶ added in v0.0.5
func (d *Database) PartitionFunctionsContext(ctx context.Context) ([]*PartitionFunction, error)
PartitionFunctionsContext is the context-aware variant of PartitionFunctions.
func (*Database) PartitionSchemeByName ¶ added in v0.0.10
func (d *Database) PartitionSchemeByName(name string) (*PartitionScheme, error)
PartitionSchemeByName returns one partition scheme by name.
func (*Database) PartitionSchemeByNameContext ¶ added in v0.0.10
func (d *Database) PartitionSchemeByNameContext(ctx context.Context, name string) (*PartitionScheme, error)
PartitionSchemeByNameContext is the context-aware variant of PartitionSchemeByName.
func (*Database) PartitionSchemeSeq ¶ added in v0.0.5
PartitionSchemeSeq returns an iterator over all partition schemes in the database.
func (*Database) PartitionSchemes ¶
func (d *Database) PartitionSchemes() ([]*PartitionScheme, error)
PartitionSchemes returns all partition schemes in the database.
func (*Database) PartitionSchemesContext ¶ added in v0.0.5
func (d *Database) PartitionSchemesContext(ctx context.Context) ([]*PartitionScheme, error)
PartitionSchemesContext is the context-aware variant of PartitionSchemes.
func (*Database) PermissionSeq ¶ added in v0.0.6
func (d *Database) PermissionSeq(ctx context.Context, schema, name string) iter.Seq2[*PermissionEntry, error]
PermissionSeq returns an iterator over the GRANT/DENY entries recorded for schema.name.
func (*Database) Permissions ¶ added in v0.0.4
func (d *Database) Permissions(schema, name string) ([]*PermissionEntry, error)
Permissions returns the GRANT/DENY entries recorded for schema.name — SSMS's object Properties > Permissions page.
func (*Database) PermissionsContext ¶ added in v0.0.4
func (d *Database) PermissionsContext(ctx context.Context, schema, name string) ([]*PermissionEntry, error)
PermissionsContext is the context-aware variant of Permissions.
func (*Database) PermissionsForPrincipal ¶ added in v0.0.5
func (d *Database) PermissionsForPrincipal(principal string) ([]*PrincipalSecurable, error)
PermissionsForPrincipal returns every explicit GRANT/DENY entry recorded for principal across database-, schema-, and table/view-scoped securables. Stored procedure and function securables are deliberately excluded — they need their own permission catalog (EXECUTE-centric, distinct from the table/view one) not built yet; see SchemaPermissionNames/ ObjectPermissionNames for the catalogs this DOES cover.
func (*Database) PermissionsForPrincipalContext ¶ added in v0.0.5
func (d *Database) PermissionsForPrincipalContext(ctx context.Context, principal string) ([]*PrincipalSecurable, error)
PermissionsForPrincipalContext is the context-aware variant of PermissionsForPrincipal.
func (*Database) PermissionsForPrincipalSeq ¶ added in v0.0.6
func (d *Database) PermissionsForPrincipalSeq(ctx context.Context, principal string) iter.Seq2[*PrincipalSecurable, error]
PermissionsForPrincipalSeq returns an iterator over every explicit GRANT/DENY entry recorded for principal across database-, schema-, and table/view-scoped securables.
func (*Database) QueryStore ¶ added in v0.0.5
func (d *Database) QueryStore() (*QueryStoreInfo, error)
QueryStore returns the database's Query Store configuration and state.
func (*Database) QueryStoreContext ¶ added in v0.0.5
func (d *Database) QueryStoreContext(ctx context.Context) (*QueryStoreInfo, error)
QueryStoreContext is the context-aware variant of QueryStore.
func (*Database) RecoveryModel ¶
func (d *Database) RecoveryModel() RecoveryModel
RecoveryModel returns the database recovery model.
func (*Database) RecoveryStatus ¶ added in v0.0.10
func (d *Database) RecoveryStatus() (*DatabaseRecoveryStatus, error)
RecoveryStatus returns this database's place in its log backup chain.
func (*Database) RecoveryStatusContext ¶ added in v0.0.10
func (d *Database) RecoveryStatusContext(ctx context.Context) (*DatabaseRecoveryStatus, error)
RecoveryStatusContext is the context-aware variant of RecoveryStatus.
func (*Database) RemoveFile ¶ added in v0.0.4
RemoveFile drops a file from the database. The file must be empty (0 bytes of used space) — SQL Server itself enforces this, not gosmo.
func (*Database) RemoveFileContext ¶ added in v0.0.4
RemoveFileContext is the context-aware variant of RemoveFile.
func (*Database) RemoveFileGroup ¶ added in v0.0.4
RemoveFileGroup drops a filegroup. It must be empty (no files) — SQL Server itself enforces this, not gosmo.
func (*Database) RemoveFileGroupContext ¶ added in v0.0.4
RemoveFileGroupContext is the context-aware variant of RemoveFileGroup.
func (*Database) RemoveRoleMember ¶
RemoveRoleMember removes a user from a database role.
func (*Database) RemoveRoleMemberContext ¶
RemoveRoleMemberContext is the context-aware variant.
func (*Database) RenameObject ¶ added in v0.0.9
RenameObject renames any schema-scoped object sp_rename's default 'OBJECT' type covers — a view, procedure, function, sequence, synonym, or trigger. A table is the same statement with its own wording; see RenameTable. An index, statistic, or column each needs its own @objtype and has its own method.
newName is a bare name: sp_rename refuses a qualified one, and renaming does not move the object between schemas (ALTER SCHEMA ... TRANSFER does).
func (*Database) RenameObjectContext ¶ added in v0.0.9
RenameObjectContext is the context-aware variant of RenameObject.
func (*Database) RenameTable ¶
RenameTable renames a table using sp_rename.
func (*Database) RenameTableContext ¶
RenameTableContext is the context-aware variant of RenameTable.
func (*Database) RevokeColumnPermission ¶ added in v0.0.8
func (d *Database) RevokeColumnPermission(schema, name string, permission ObjectPermission, columns []string, principal string) error
RevokeColumnPermission revokes permission on the named columns of schema.name from principal.
func (*Database) RevokeColumnPermissionContext ¶ added in v0.0.8
func (d *Database) RevokeColumnPermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, columns []string, principal string) error
RevokeColumnPermissionContext is the context-aware variant of RevokeColumnPermission.
func (*Database) RevokeColumnPermissionWithOptions ¶ added in v0.0.8
func (d *Database) RevokeColumnPermissionWithOptions(schema, name string, permission ObjectPermission, columns []string, principal string, opts PermissionOptions) error
RevokeColumnPermissionWithOptions revokes a column-level permission honouring opts — the CASCADE and GRANT OPTION FOR forms of RevokeColumnPermission.
func (*Database) RevokeColumnPermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) RevokeColumnPermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, columns []string, principal string, opts PermissionOptions) error
RevokeColumnPermissionWithOptionsContext is the context-aware variant of RevokeColumnPermissionWithOptions.
func (*Database) RevokeDatabasePermission ¶ added in v0.0.4
RevokeDatabasePermission revokes a database-level permission from principal.
func (*Database) RevokeDatabasePermissionContext ¶ added in v0.0.4
func (d *Database) RevokeDatabasePermissionContext(ctx context.Context, permission, principal string) error
RevokeDatabasePermissionContext is the context-aware variant of RevokeDatabasePermission.
func (*Database) RevokeDatabasePermissionWithOptions ¶ added in v0.0.8
func (d *Database) RevokeDatabasePermissionWithOptions(permission, principal string, opts PermissionOptions) error
RevokeDatabasePermissionWithOptions revokes a database-level permission from principal, honouring opts.
func (*Database) RevokeDatabasePermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) RevokeDatabasePermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
RevokeDatabasePermissionWithOptionsContext is the context-aware variant of RevokeDatabasePermissionWithOptions.
func (*Database) RevokePermission ¶ added in v0.0.4
func (d *Database) RevokePermission(schema, name string, permission ObjectPermission, principal string) error
RevokePermission revokes permission on schema.name from principal.
func (*Database) RevokePermissionContext ¶ added in v0.0.4
func (d *Database) RevokePermissionContext(ctx context.Context, schema, name string, permission ObjectPermission, principal string) error
RevokePermissionContext is the context-aware variant of RevokePermission.
func (*Database) RevokePermissionWithOptions ¶ added in v0.0.8
func (d *Database) RevokePermissionWithOptions(schema, name string, permission ObjectPermission, principal string, opts PermissionOptions) error
RevokePermissionWithOptions revokes permission on schema.name from principal, honouring opts — the CASCADE and GRANT OPTION FOR forms of RevokePermission.
func (*Database) RevokePermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) RevokePermissionWithOptionsContext(ctx context.Context, schema, name string, permission ObjectPermission, principal string, opts PermissionOptions) error
RevokePermissionWithOptionsContext is the context-aware variant of RevokePermissionWithOptions.
func (*Database) RevokeSchemaPermission ¶ added in v0.0.5
func (d *Database) RevokeSchemaPermission(schemaName string, permission ObjectPermission, principal string) error
RevokeSchemaPermission revokes permission on a schema from principal.
func (*Database) RevokeSchemaPermissionContext ¶ added in v0.0.5
func (d *Database) RevokeSchemaPermissionContext(ctx context.Context, schemaName string, permission ObjectPermission, principal string) error
RevokeSchemaPermissionContext is the context-aware variant of RevokeSchemaPermission.
func (*Database) RevokeSchemaPermissionWithOptions ¶ added in v0.0.8
func (d *Database) RevokeSchemaPermissionWithOptions(schemaName string, permission ObjectPermission, principal string, opts PermissionOptions) error
RevokeSchemaPermissionWithOptions revokes permission on a schema from principal, honouring opts.
func (*Database) RevokeSchemaPermissionWithOptionsContext ¶ added in v0.0.8
func (d *Database) RevokeSchemaPermissionWithOptionsContext(ctx context.Context, schemaName string, permission ObjectPermission, principal string, opts PermissionOptions) error
RevokeSchemaPermissionWithOptionsContext is the context-aware variant of RevokeSchemaPermissionWithOptions.
func (*Database) RoleByName ¶ added in v0.0.5
func (d *Database) RoleByName(name string) (*DatabaseRole, error)
RoleByName returns a single database role by name, with its principal detail (SID, create/modify dates) filled in — DatabaseRolesContext leaves these out since Object Explorer's tree listing never needs them.
func (*Database) RoleByNameContext ¶ added in v0.0.5
RoleByNameContext is the context-aware variant of RoleByName.
func (*Database) RoleMemberSeq ¶ added in v0.0.6
func (d *Database) RoleMemberSeq(ctx context.Context, roleName string) iter.Seq2[*RoleMember, error]
RoleMemberSeq returns an iterator over a database role's members.
func (*Database) RoleMembers ¶ added in v0.0.5
func (d *Database) RoleMembers(roleName string) ([]*RoleMember, error)
RoleMembers returns the direct members of a database role, with each member's principal type — DatabaseRolesContext/RoleByNameContext only return member names, concatenated, with no type.
func (*Database) RoleMembersContext ¶ added in v0.0.5
RoleMembersContext is the context-aware variant of RoleMembers.
func (*Database) SchemaByName ¶ added in v0.0.10
SchemaByName returns one schema by name.
func (*Database) SchemaByNameContext ¶ added in v0.0.10
SchemaByNameContext is the context-aware variant of SchemaByName. It returns an error satisfying errors.Is(err, ErrNotFound) when the database has no such schema.
func (*Database) SchemaPermissionSeq ¶ added in v0.0.6
func (d *Database) SchemaPermissionSeq(ctx context.Context, schemaName string) iter.Seq2[*PermissionEntry, error]
SchemaPermissionSeq returns an iterator over a schema's explicit GRANT/DENY entries.
func (*Database) SchemaPermissions ¶ added in v0.0.5
func (d *Database) SchemaPermissions(schemaName string) ([]*PermissionEntry, error)
SchemaPermissions returns the GRANT/DENY entries recorded on SCHEMA::schemaName — SSMS's Schema Properties > Permissions page. This is the schema-scoped analog of Permissions: that one resolves its securable via OBJECT_ID(schema.name), which only works for table/view securables — a schema has no OBJECT_ID, so it needs its own query keyed on SCHEMA_ID instead.
func (*Database) SchemaPermissionsContext ¶ added in v0.0.5
func (d *Database) SchemaPermissionsContext(ctx context.Context, schemaName string) ([]*PermissionEntry, error)
SchemaPermissionsContext is the context-aware variant of SchemaPermissions.
func (*Database) SchemasContext ¶
SchemasContext is the context-aware variant of Schemas.
func (*Database) Search ¶ added in v0.0.4
func (d *Database) Search(pattern string) ([]*SearchResult, error)
Search finds tables, views, stored procedures, functions, and triggers whose name contains pattern (case-insensitivity follows the database's own collation), matching SSMS's Object Explorer Details search box.
func (*Database) SearchContext ¶ added in v0.0.4
SearchContext is the context-aware variant of Search.
func (*Database) SearchSeq ¶ added in v0.0.6
SearchSeq returns an iterator over every table, view, stored procedure, function, and trigger whose name contains pattern.
func (*Database) SecurityPolicies ¶
func (d *Database) SecurityPolicies() ([]*SecurityPolicy, error)
SecurityPolicies returns all security policies in the database.
func (*Database) SecurityPoliciesContext ¶ added in v0.0.5
func (d *Database) SecurityPoliciesContext(ctx context.Context) ([]*SecurityPolicy, error)
SecurityPoliciesContext is the context-aware variant of SecurityPolicies.
func (*Database) SecurityPolicyByName ¶ added in v0.0.10
func (d *Database) SecurityPolicyByName(schema, name string) (*SecurityPolicy, error)
SecurityPolicyByName returns one security policy by schema-qualified name.
func (*Database) SecurityPolicyByNameContext ¶ added in v0.0.10
func (d *Database) SecurityPolicyByNameContext(ctx context.Context, schema, name string) (*SecurityPolicy, error)
SecurityPolicyByNameContext is the context-aware variant of SecurityPolicyByName.
func (*Database) SecurityPolicySeq ¶ added in v0.0.5
SecurityPolicySeq returns an iterator over all security policies in the database.
func (*Database) SequenceSeq ¶
SequenceSeq returns an iterator over all sequences in the database.
func (*Database) SequencesContext ¶ added in v0.0.4
SequencesContext is the context-aware variant of Sequences.
func (*Database) SetChangeTracking ¶ added in v0.0.4
func (d *Database) SetChangeTracking(info ChangeTrackingInfo) error
SetChangeTracking enables, reconfigures, or disables change tracking for the database. info.RetentionUnit defaults to "DAYS" when empty.
func (*Database) SetChangeTrackingContext ¶ added in v0.0.4
func (d *Database) SetChangeTrackingContext(ctx context.Context, info ChangeTrackingInfo) error
SetChangeTrackingContext is the context-aware variant of SetChangeTracking.
func (*Database) SetCompatibilityLevel ¶
func (d *Database) SetCompatibilityLevel(level CompatibilityLevel) error
SetCompatibilityLevel changes the database compatibility level.
func (*Database) SetCompatibilityLevelContext ¶
func (d *Database) SetCompatibilityLevelContext(ctx context.Context, level CompatibilityLevel) error
SetCompatibilityLevelContext is the context-aware variant.
func (*Database) SetDatabaseOption ¶ added in v0.0.4
func (d *Database) SetDatabaseOption(opt DatabaseOption, value string) error
SetDatabaseOption changes one ALTER DATABASE ... SET option. value is the keyword or clause that follows the option name verbatim, e.g. "ON", "OFF", "CHECKSUM", "PARTIAL", "SNAPSHOT_ISOLATION" — see SQL Server's ALTER DATABASE SET reference for each option's accepted values.
func (*Database) SetDatabaseOptionContext ¶ added in v0.0.4
func (d *Database) SetDatabaseOptionContext(ctx context.Context, opt DatabaseOption, value string) error
SetDatabaseOptionContext is the context-aware variant of SetDatabaseOption.
func (*Database) SetDatabaseScopedConfig ¶ added in v0.0.5
SetDatabaseScopedConfig changes one database scoped configuration option. value is the keyword or literal that follows the option name verbatim, e.g. "ON", "OFF", "4" — see ALTER DATABASE SCOPED CONFIGURATION's reference for each option's accepted values. forSecondary applies the change to readable secondary replicas (FOR SECONDARY) instead of the primary.
func (*Database) SetDatabaseScopedConfigContext ¶ added in v0.0.5
func (d *Database) SetDatabaseScopedConfigContext(ctx context.Context, name, value string, forSecondary bool) error
SetDatabaseScopedConfigContext is the context-aware variant of SetDatabaseScopedConfig. Unlike ALTER DATABASE SET options (SetDatabaseOptionContext), ALTER DATABASE SCOPED CONFIGURATION is scoped to whichever database is current, so this runs through d.exec (USE first), not d.server.execContext.
func (*Database) SetDefaultFileGroup ¶ added in v0.0.4
SetDefaultFileGroup marks a filegroup as the database's default.
func (*Database) SetDefaultFileGroupContext ¶ added in v0.0.4
SetDefaultFileGroupContext is the context-aware variant of SetDefaultFileGroup.
func (*Database) SetExtendedProperty ¶ added in v0.0.4
func (d *Database) SetExtendedProperty(name, value string, level ExtendedPropertyLevel) error
SetExtendedProperty updates the value of an existing extended property. Fails if no property with this name exists at this level — see AddExtendedProperty to create one.
func (*Database) SetExtendedPropertyContext ¶ added in v0.0.4
func (d *Database) SetExtendedPropertyContext(ctx context.Context, name, value string, level ExtendedPropertyLevel) error
SetExtendedPropertyContext is the context-aware variant of SetExtendedProperty.
func (*Database) SetFileGroupReadOnly ¶ added in v0.0.4
SetFileGroupReadOnly sets or clears a filegroup's read-only flag.
func (*Database) SetFileGroupReadOnlyContext ¶ added in v0.0.4
func (d *Database) SetFileGroupReadOnlyContext(ctx context.Context, name string, readOnly bool) error
SetFileGroupReadOnlyContext is the context-aware variant of SetFileGroupReadOnly.
The keywords are the underscored spellings on purpose. ALTER DATABASE also accepts READONLY/READWRITE, but only for backward compatibility — SQL Server documents that pair as deprecated and slated for removal, and it is the spelling this used to emit.
func (*Database) SetOffline ¶ added in v0.0.5
SetOffline takes the database offline.
func (*Database) SetOfflineContext ¶ added in v0.0.5
SetOfflineContext is the context-aware variant of SetOffline. Existing connections are rolled back immediately, matching SSMS's Object Explorer "Take Database Offline" behavior.
func (*Database) SetOnlineContext ¶ added in v0.0.5
SetOnlineContext is the context-aware variant of SetOnline.
func (*Database) SetOwner ¶ added in v0.0.4
SetOwner transfers database ownership to a new principal.
func (*Database) SetOwnerContext ¶ added in v0.0.4
SetOwnerContext is the context-aware variant of SetOwner.
func (*Database) SetQueryStoreOptions ¶ added in v0.0.5
func (d *Database) SetQueryStoreOptions(opts QueryStoreOptions) error
SetQueryStoreOptions turns Query Store on (reconfiguring it) or off.
func (*Database) SetQueryStoreOptionsContext ¶ added in v0.0.5
func (d *Database) SetQueryStoreOptionsContext(ctx context.Context, opts QueryStoreOptions) error
SetQueryStoreOptionsContext is the context-aware variant of SetQueryStoreOptions. Like SetRecoveryModelContext, this is an ALTER DATABASE statement naming the database explicitly, so it runs through d.server.execContext rather than d.exec.
func (*Database) SetReadOnly ¶
SetReadOnly sets the database to read-only or read-write.
func (*Database) SetReadOnlyContext ¶
SetReadOnlyContext is the context-aware variant.
func (*Database) SetRecoveryModel ¶
func (d *Database) SetRecoveryModel(model RecoveryModel) error
SetRecoveryModel changes the database recovery model.
func (*Database) SetRecoveryModelContext ¶
func (d *Database) SetRecoveryModelContext(ctx context.Context, model RecoveryModel) error
SetRecoveryModelContext is the context-aware variant.
func (*Database) SetTableChangeTracking ¶ added in v0.0.4
SetTableChangeTracking enables or disables change tracking on one table. trackColumns is ignored when enable is false.
func (*Database) SetTableChangeTrackingContext ¶ added in v0.0.4
func (d *Database) SetTableChangeTrackingContext(ctx context.Context, schema, name string, enable, trackColumns bool) error
SetTableChangeTrackingContext is the context-aware variant of SetTableChangeTracking.
func (*Database) SetUserAccess ¶ added in v0.0.5
SetUserAccess changes the database's user-access mode (MULTI_USER, SINGLE_USER, or RESTRICTED_USER — SSMS's Database Properties > Options "Restrict access" setting). Existing connections that would violate the new mode are rolled back immediately, matching SSMS's own behavior.
func (*Database) SetUserAccessContext ¶ added in v0.0.5
SetUserAccessContext is the context-aware variant of SetUserAccess.
func (*Database) SpaceUsedContext ¶
SpaceUsedContext is the context-aware variant of SpaceUsed.
func (*Database) StoredProcedureSeq ¶
StoredProcedureSeq returns an iterator over all stored procedures.
func (*Database) StoredProcedures ¶
func (d *Database) StoredProcedures() ([]*StoredProcedure, error)
StoredProcedures returns all stored procedures in the database.
func (*Database) StoredProceduresContext ¶
func (d *Database) StoredProceduresContext(ctx context.Context) ([]*StoredProcedure, error)
StoredProceduresContext is the context-aware variant of StoredProcedures.
func (*Database) StoredProceduresFiltered ¶ added in v0.0.10
func (d *Database) StoredProceduresFiltered(filter ObjectFilter) ([]*StoredProcedure, error)
StoredProceduresFiltered returns the stored procedures an ObjectFilter matches, narrowed by the server. An empty filter is StoredProceduresContext.
func (*Database) StoredProceduresFilteredContext ¶ added in v0.0.10
func (d *Database) StoredProceduresFilteredContext(ctx context.Context, filter ObjectFilter) ([]*StoredProcedure, error)
StoredProceduresFilteredContext is the context-aware variant of StoredProceduresFiltered.
func (*Database) SynonymSeq ¶ added in v0.0.5
SynonymSeq returns an iterator over all synonyms in the database.
func (*Database) SynonymsContext ¶ added in v0.0.4
SynonymsContext is the context-aware variant of Synonyms.
func (*Database) SystemCatalog ¶ added in v0.0.5
SystemCatalog returns a bulk snapshot of every catalog view in the "sys" schema (sys.tables, sys.columns, sys.objects, ...) — see SystemCatalogContext.
func (*Database) SystemCatalogContext ¶ added in v0.0.5
SystemCatalogContext is the context-aware variant of SystemCatalog. The "sys" schema's catalog views are defined identically in every database on a server, so a caller only needs to load this once per connection — any database works equally well as the query target, not just master.
Unlike CatalogContext, this queries sys.all_objects/sys.all_columns rather than sys.objects/sys.columns: the latter two, despite the generic names, only ever surface user-created objects (is_ms_shipped=1 rows are invisible through them) — sys.tables, sys.columns, sys.objects itself, and every other built-in catalog view only show up through the "all_" variants.
func (*Database) SystemFunctionSeq ¶ added in v0.0.5
SystemFunctionSeq returns an iterator over every system function in the "sys" schema.
func (*Database) SystemFunctions ¶ added in v0.0.5
func (d *Database) SystemFunctions() ([]*UserDefinedFunction, error)
SystemFunctions returns every system function SQL Server ships in the "sys" schema (sys.fn_listextendedproperty, ...) — see SystemFunctionsContext.
func (*Database) SystemFunctionsContext ¶ added in v0.0.5
func (d *Database) SystemFunctionsContext(ctx context.Context) ([]*UserDefinedFunction, error)
SystemFunctionsContext is the context-aware variant of SystemFunctions. Reads sys.all_objects rather than sys.objects for the same reason SystemViewsContext reads sys.all_objects instead of sys.views: shipped objects are invisible through the non-"all_" catalog views. Restricted to the same type set as UserDefinedFunctionsContext ('FN'/'TF'/'IF') — aggregate ('AF') and CLR scalar ('FS') functions are excluded, matching that same scope. The "sys" schema is identical in every database on a server, so this only needs loading once per connection.
func (*Database) SystemFunctionsFiltered ¶ added in v0.0.10
func (d *Database) SystemFunctionsFiltered(filter ObjectFilter) ([]*UserDefinedFunction, error)
SystemFunctionsFiltered returns the system functions an ObjectFilter matches, narrowed by the server. An empty filter is SystemFunctionsContext.
func (*Database) SystemFunctionsFilteredContext ¶ added in v0.0.10
func (d *Database) SystemFunctionsFilteredContext(ctx context.Context, filter ObjectFilter) ([]*UserDefinedFunction, error)
SystemFunctionsFilteredContext is the context-aware variant of SystemFunctionsFiltered.
func (*Database) SystemStoredProcedureSeq ¶ added in v0.0.5
SystemStoredProcedureSeq returns an iterator over every system stored procedure in the "sys" schema.
func (*Database) SystemStoredProcedures ¶ added in v0.0.5
func (d *Database) SystemStoredProcedures() ([]*StoredProcedure, error)
SystemStoredProcedures returns every system stored procedure SQL Server ships in the "sys" schema (sp_help, sp_who, ...) — see SystemStoredProceduresContext.
func (*Database) SystemStoredProceduresContext ¶ added in v0.0.5
func (d *Database) SystemStoredProceduresContext(ctx context.Context) ([]*StoredProcedure, error)
SystemStoredProceduresContext is the context-aware variant of SystemStoredProcedures. Reads sys.all_objects rather than sys.procedures for the same reason SystemViewsContext reads sys.all_objects instead of sys.views: shipped objects are invisible through the non-"all_" catalog views. Restricted to types 'P'/'PC' (SQL/CLR stored procedure), matching what sys.procedures itself documents — extended stored procedures ('X', e.g. xp_cmdshell) are a distinct object kind and excluded. The "sys" schema is identical in every database on a server, so this only needs loading once per connection.
func (*Database) SystemStoredProceduresFiltered ¶ added in v0.0.10
func (d *Database) SystemStoredProceduresFiltered(filter ObjectFilter) ([]*StoredProcedure, error)
SystemStoredProceduresFiltered returns the system stored procedures an ObjectFilter matches, narrowed by the server. An empty filter is SystemStoredProceduresContext.
func (*Database) SystemStoredProceduresFilteredContext ¶ added in v0.0.10
func (d *Database) SystemStoredProceduresFilteredContext(ctx context.Context, filter ObjectFilter) ([]*StoredProcedure, error)
SystemStoredProceduresFilteredContext is the context-aware variant of SystemStoredProceduresFiltered.
func (*Database) SystemViewSeq ¶ added in v0.0.5
SystemViewSeq returns an iterator over every system catalog view in the "sys" schema.
func (*Database) SystemViews ¶ added in v0.0.5
SystemViews returns every catalog view SQL Server ships in the "sys" schema (sys.tables, sys.columns, sys.objects, ...) — see SystemViewsContext.
func (*Database) SystemViewsContext ¶ added in v0.0.5
SystemViewsContext is the context-aware variant of SystemViews. Unlike Views, this reads sys.all_objects/sys.all_sql_modules rather than sys.views/sys.sql_modules: the "sys." schema's own views are shipped objects (is_ms_shipped=1), invisible through the non-"all_" catalog views — same reasoning as SystemCatalogContext. The "sys" schema's catalog views are defined identically in every database on a server, so a caller only needs to load this once per connection.
func (*Database) SystemViewsFiltered ¶ added in v0.0.10
func (d *Database) SystemViewsFiltered(filter ObjectFilter) ([]*View, error)
SystemViewsFiltered returns the system views an ObjectFilter matches, narrowed by the server. An empty filter is SystemViewsContext.
func (*Database) SystemViewsFilteredContext ¶ added in v0.0.10
func (d *Database) SystemViewsFilteredContext(ctx context.Context, filter ObjectFilter) ([]*View, error)
SystemViewsFilteredContext is the context-aware variant of SystemViewsFiltered.
func (*Database) Table ¶ added in v0.0.9
Table returns a lightweight handle to a table by name, without a query. Nothing verifies that the table exists, and every field but Schema and Name stays at its zero value — ObjectID included.
That is the limit of what this handle is for: the methods it serves are the name-only ones, which name the table in the statement text (DropConstraint, Rename, the ALTER-style writes). Every method that queries by ObjectID — Columns, Indexes, Statistics, Triggers, Partitions, the size and detail reads — would find object 0 and return nothing, so those need a Table from Tables/TableByName instead.
Like Server.Database, this is also the only form that works under a WithScript-derived context, where no lookup can run at all.
func (*Database) TableByName ¶
TableByName returns a single table by schema and name using a direct query.
func (*Database) TableByNameContext ¶
TableByNameContext is the context-aware variant of TableByName.
func (*Database) TableChangeTracking ¶ added in v0.0.4
func (d *Database) TableChangeTracking() ([]*TableChangeTracking, error)
TableChangeTracking returns change tracking state for every user table in the database, whether or not tracking is actually enabled on it.
func (*Database) TableChangeTrackingContext ¶ added in v0.0.4
func (d *Database) TableChangeTrackingContext(ctx context.Context) ([]*TableChangeTracking, error)
TableChangeTrackingContext is the context-aware variant of TableChangeTracking.
func (*Database) TableChangeTrackingFor ¶ added in v0.0.10
func (d *Database) TableChangeTrackingFor(schema, name string) (*TableChangeTracking, error)
TableChangeTrackingFor returns change tracking state for one user table.
func (*Database) TableChangeTrackingForContext ¶ added in v0.0.10
func (d *Database) TableChangeTrackingForContext(ctx context.Context, schema, name string) (*TableChangeTracking, error)
TableChangeTrackingForContext is the context-aware variant of TableChangeTrackingFor. A table that exists but has tracking switched off is not an error — it comes back with Enabled false. The error satisfies errors.Is(err, ErrNotFound) only when the database has no such user table.
func (*Database) TableChangeTrackingSeq ¶ added in v0.0.4
func (d *Database) TableChangeTrackingSeq(ctx context.Context) iter.Seq2[*TableChangeTracking, error]
TableChangeTrackingSeq returns an iterator over every user table's change tracking state.
func (*Database) TableRowCounts ¶ added in v0.0.7
TableRowCounts returns the row count of every user table in the database, keyed by object_id — Table.RowCount for all tables in a single round trip.
Use this over a loop of Table.RowCount whenever the caller wants more than a couple of tables: the per-table form costs one query (and one pooled connection) each. The filter and aggregate are the same, so the counts are identical either way — metadata counts from sys.partitions, which is what SSMS's object grids show, not a COUNT(*).
A table with no row in sys.partitions is absent from the map rather than present as 0; callers should treat a missing key as zero rows.
func (*Database) TableRowCountsContext ¶ added in v0.0.7
TableRowCountsContext is the context-aware variant of TableRowCounts.
func (*Database) TableSpaceUsedAll ¶ added in v0.0.7
func (d *Database) TableSpaceUsedAll() (map[int]*TableSpaceInfo, error)
TableSpaceUsedAll returns space usage for every user table in the database, keyed by object_id — the same breakdown Table.SpaceUsed gives for one table, for all of them in a single round trip.
Use this over a loop of Table.SpaceUsed whenever the caller wants more than a couple of tables: the per-table form costs one query (and one pooled connection) each, so a grid listing a few hundred tables is a few hundred round trips. The aggregate expressions and joins are the same, so the numbers are identical either way.
A table with no allocated pages at all has no row in sys.partitions to aggregate and is therefore absent from the map, not present with zeroes — callers should treat a missing key as "no space used".
func (*Database) TableSpaceUsedAllContext ¶ added in v0.0.7
TableSpaceUsedAllContext is the context-aware variant of TableSpaceUsedAll.
func (*Database) TablesBySchema ¶
TablesBySchema returns all tables in a specific schema.
func (*Database) TablesBySchemaContext ¶
TablesBySchemaContext is the context-aware variant of TablesBySchema.
func (*Database) TablesBySchemaSeq ¶ added in v0.0.6
TablesBySchemaSeq returns an iterator over every user table in the given schema.
func (*Database) TablesContext ¶
TablesContext is the context-aware variant of Tables.
func (*Database) TablesFiltered ¶ added in v0.0.10
func (d *Database) TablesFiltered(filter ObjectFilter) ([]*Table, error)
TablesFiltered returns the user tables an ObjectFilter matches, narrowed by the server rather than by the caller. An empty filter is TablesContext.
func (*Database) TablesFilteredContext ¶ added in v0.0.10
func (d *Database) TablesFilteredContext(ctx context.Context, filter ObjectFilter) ([]*Table, error)
TablesFilteredContext is the context-aware variant of TablesFiltered.
func (*Database) TransferObject ¶ added in v0.0.10
TransferObject moves a schema-scoped object into another schema (ALTER SCHEMA ... TRANSFER), which is the operation sp_rename cannot do — a rename takes a bare name and never crosses schemas.
The object keeps its name and its object_id; permissions granted on it directly are dropped by the server, which is the documented behaviour of ALTER SCHEMA TRANSFER and the reason it is not a cosmetic change. An empty schema means dbo, as everywhere else here.
This is sp_rename's default 'OBJECT' class: tables, views, procedures, functions, sequences and synonyms. A type or an XML schema collection needs TRANSFER's own class prefix and is not covered.
func (*Database) TransferObjectContext ¶ added in v0.0.10
func (d *Database) TransferObjectContext(ctx context.Context, targetSchema, schema, name string) error
TransferObjectContext is the context-aware variant of TransferObject.
func (*Database) TriggerSeq ¶ added in v0.0.6
TriggerSeq returns an iterator over every DML trigger in the database (as opposed to Table.TriggerSeq's single-table scope).
func (*Database) TriggersContext ¶
TriggersContext is the context-aware variant of Triggers.
func (*Database) UserByName ¶ added in v0.0.5
UserByName returns a single database user by name, with its SID and matching server login (if any) filled in — UsersContext leaves these out since Object Explorer's tree listing never needs them.
func (*Database) UserByNameContext ¶ added in v0.0.5
UserByNameContext is the context-aware variant of UserByName.
func (*Database) UserDefinedFunctionSeq ¶ added in v0.0.6
func (d *Database) UserDefinedFunctionSeq(ctx context.Context) iter.Seq2[*UserDefinedFunction, error]
UserDefinedFunctionSeq returns an iterator over all user-created functions (as opposed to SystemFunctionSeq's "sys" schema functions).
func (*Database) UserDefinedFunctions ¶
func (d *Database) UserDefinedFunctions() ([]*UserDefinedFunction, error)
UserDefinedFunctions returns all UDFs in the database.
func (*Database) UserDefinedFunctionsContext ¶
func (d *Database) UserDefinedFunctionsContext(ctx context.Context) ([]*UserDefinedFunction, error)
UserDefinedFunctionsContext is the context-aware variant.
func (*Database) UserDefinedFunctionsFiltered ¶ added in v0.0.10
func (d *Database) UserDefinedFunctionsFiltered(filter ObjectFilter) ([]*UserDefinedFunction, error)
UserDefinedFunctionsFiltered returns the UDFs an ObjectFilter matches, narrowed by the server. An empty filter is UserDefinedFunctionsContext.
func (*Database) UserDefinedFunctionsFilteredContext ¶ added in v0.0.10
func (d *Database) UserDefinedFunctionsFilteredContext(ctx context.Context, filter ObjectFilter) ([]*UserDefinedFunction, error)
UserDefinedFunctionsFilteredContext is the context-aware variant of UserDefinedFunctionsFiltered.
func (*Database) UsersContext ¶
UsersContext is the context-aware variant of Users.
func (*Database) ViewsContext ¶
ViewsContext is the context-aware variant of Views.
func (*Database) ViewsFiltered ¶ added in v0.0.10
func (d *Database) ViewsFiltered(filter ObjectFilter) ([]*View, error)
ViewsFiltered returns the views an ObjectFilter matches, narrowed by the server rather than by the caller. An empty filter is ViewsContext.
func (*Database) ViewsFilteredContext ¶ added in v0.0.10
ViewsFilteredContext is the context-aware variant of ViewsFiltered.
type DatabaseCapabilities ¶ added in v0.0.10
type DatabaseCapabilities struct {
// Accessible reports HAS_DBACCESS: whether the login can open the
// database at all. When it is false the two maps are empty, because
// nothing inside the database could be asked — a USE into it fails.
//
// This is the one field to check before expanding a database in a tree or
// opening its properties: every folder under an inaccessible database
// fails separately and identically.
Accessible bool
// Roles maps each name in ProbedDatabaseRoles to membership.
Roles map[string]bool
// Permissions maps each name in ProbedDatabasePermissions to its state.
Permissions map[string]CapabilityState
}
DatabaseCapabilities is what the connected login may do inside one database.
Obtain one with Database.Capabilities. Every method is nil-safe.
func (*DatabaseCapabilities) Allows ¶ added in v0.0.10
func (c *DatabaseCapabilities) Allows(name string) bool
Allows reports that the permission is not known to be denied. See Capabilities.Allows, which explains why it and Has are not opposites.
At database scope this is *not* the whole test for withholding something — use Permits. Allows answers only the question it is asked, and an inaccessible database was never asked anything.
func (*DatabaseCapabilities) Has ¶ added in v0.0.10
func (c *DatabaseCapabilities) Has(name string) bool
Has reports that the permission is known to be held — the test for offering something extra. See Capabilities.Has.
func (*DatabaseCapabilities) InRole ¶ added in v0.0.10
func (c *DatabaseCapabilities) InRole(name string) bool
InRole reports whether the login's user in this database is a member of the named fixed database role. As with Capabilities.InServerRole, membership in db_owner (or in sysadmin) is not folded in.
func (*DatabaseCapabilities) Permission ¶ added in v0.0.10
func (c *DatabaseCapabilities) Permission(name string) CapabilityState
Permission returns the state of one database-scope permission. A name that was never probed is CapabilityUnknown.
func (*DatabaseCapabilities) Permits ¶ added in v0.0.10
func (c *DatabaseCapabilities) Permits(name string) bool
Permits is the test for withholding something at database scope: Allows, plus the accessibility the permission answer takes for granted.
A database the login cannot open answers CapabilityUnknown to every permission, because there was nothing inside it to ask — Accessible false is the only thing the server said. Unknown fails open, so Allows alone reports "not known to be denied" for a database the login cannot so much as connect to, and a caller following Capabilities.Allows's advice would offer Back Up and Delete on exactly the databases it has no business writing to.
The fail-open direction is kept where it belongs: a probe that could not run at all leaves Accessible true (see Database.CapabilitiesContext), so Permits still says yes there. Only a measured "cannot open this" withholds.
Capabilities has no counterpart because there is no server-scope equivalent of an inaccessible database: a login that cannot reach the instance has no Capabilities to ask.
One shape to know: a nil *DatabaseCapabilities is "nothing known" and fails open, but the *zero value* is not — its Accessible is false, which reads as a measured "cannot open this" and withholds. Anything hand-building one to stand in for a probe that could not run must set Accessible true, the way CapabilitiesContext does for every database it reached.
type DatabaseFile ¶
type DatabaseFile struct {
Name string
PhysicalName string
Size int64 // in KB
MaxSize int64 // in KB; -1 = unlimited
GrowthType string // "KB" | "PERCENT"
Growth int64
IsPrimaryFile bool
FileGroupName string
}
DatabaseFile represents a single data or log file.
type DatabaseFileInfo ¶ added in v0.0.4
type DatabaseFileInfo struct {
FileID int
Name string
PhysicalName string
Type string // "ROWS", "LOG", or "FILESTREAM" (sys.database_files.type_desc)
FileGroup string // "" for log files, which don't belong to one
State string // e.g. "ONLINE"
SizeKB int64
MaxSizeKB int64 // -1 = unlimited
GrowthKB int64 // 0 when IsPercentGrowth is true
GrowthPercent int // 0 when IsPercentGrowth is false
IsPercentGrowth bool
}
DatabaseFileInfo describes a single database file, including log files — unlike FileGroups/FileGroupsContext (database.go), which only sees files that belong to a filegroup and so omits the log. Sizes are normalized to KB (FileGroupsContext's MaxSize/Growth fields are not, for backward compatibility with existing callers).
type DatabaseFileSpec ¶ added in v0.0.4
type DatabaseFileSpec struct {
Name string
FileGroup string // ignored when Type is "LOG"
Type string // "LOG" adds a log file; anything else (including "") adds a data file
Path string
SizeKB int64
// GrowthKB and GrowthPercent are mutually exclusive; GrowthPercent
// wins if both are set. Leaving both zero omits FILEGROWTH (server
// default).
GrowthKB int64
GrowthPercent int
// DisableGrowth creates the file with autogrowth off (FILEGROWTH = 0),
// and takes precedence over GrowthKB/GrowthPercent. It exists because
// zero cannot say it: leaving both growth fields at zero means "omit
// FILEGROWTH, take the server default", which is the opposite of
// switching growth off.
DisableGrowth bool
// MaxSizeKB: 0 omits MAXSIZE (server default), -1 means UNLIMITED,
// >0 is the cap in KB.
MaxSizeKB int64
}
DatabaseFileSpec describes a file to add via AddFile.
type DatabaseMirroringEndpoint ¶ added in v0.0.9
type DatabaseMirroringEndpoint struct {
Name string
Port int
// State is STARTED, STOPPED or DISABLED. Only a STARTED endpoint accepts
// connections, and an endpoint left STOPPED is the usual reason a replica
// that looks correctly configured never synchronizes.
State string
// Role is ALL, PARTNER or WITNESS. Availability groups need ALL.
Role string
IsEncryptionEnabled bool
// EncryptionAlgorithm is AES, RC4, or one of the mixed forms. RC4 is
// deprecated and refused outright on recent versions.
EncryptionAlgorithm string
// ConnectionAuth is how the far end proves who it is — NTLM, KERBEROS,
// NEGOTIATE, CERTIFICATE, or one of the combined forms. A Linux
// availability group is normally CERTIFICATE, since the instances share no
// domain; a Windows one is normally NEGOTIATE.
ConnectionAuth string
// Owner is the login that owns the endpoint.
Owner string
// contains filtered or unexported fields
}
DatabaseMirroringEndpoint is an instance's database mirroring endpoint.
func (*DatabaseMirroringEndpoint) Drop ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) Drop() error
Drop deletes the endpoint.
func (*DatabaseMirroringEndpoint) DropContext ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
func (*DatabaseMirroringEndpoint) GrantConnect ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) GrantConnect(login string) error
GrantConnect grants a login CONNECT on the endpoint — what lets the other replicas' service accounts open a connection to it.
func (*DatabaseMirroringEndpoint) GrantConnectContext ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) GrantConnectContext(ctx context.Context, login string) error
GrantConnectContext is the context-aware variant of GrantConnect.
func (*DatabaseMirroringEndpoint) Server ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) Server() *Server
Server returns the connection this endpoint was read from.
func (*DatabaseMirroringEndpoint) Start ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) Start() error
Start starts a stopped endpoint. An endpoint that is not STARTED accepts no connections, so a replica behind one never synchronizes.
func (*DatabaseMirroringEndpoint) StartContext ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) StartContext(ctx context.Context) error
StartContext is the context-aware variant of Start.
func (*DatabaseMirroringEndpoint) Stop ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) Stop() error
Stop stops the endpoint, breaking every replica connection through it.
func (*DatabaseMirroringEndpoint) StopContext ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) StopContext(ctx context.Context) error
StopContext is the context-aware variant of Stop.
func (*DatabaseMirroringEndpoint) URL ¶ added in v0.0.9
func (e *DatabaseMirroringEndpoint) URL() string
URL is the endpoint's address as an availability replica's ENDPOINT_URL — "tcp://<server>:<port>", built from the instance's own name.
The host is the server's name rather than whatever address the client connected through, because this string is consumed by the *other* replicas: they resolve it themselves, and the address that reached this instance from here may be meaningless there.
type DatabaseOption ¶ added in v0.0.4
type DatabaseOption string
DatabaseOption identifies one ALTER DATABASE ... SET option.
const ( DBOptAutoClose DatabaseOption = "AUTO_CLOSE" DBOptAutoShrink DatabaseOption = "AUTO_SHRINK" DBOptAutoCreateStatistics DatabaseOption = "AUTO_CREATE_STATISTICS" DBOptAutoUpdateStatistics DatabaseOption = "AUTO_UPDATE_STATISTICS" DBOptAutoUpdateStatisticsAsync DatabaseOption = "AUTO_UPDATE_STATISTICS_ASYNC" DBOptANSINullDefault DatabaseOption = "ANSI_NULL_DEFAULT" DBOptANSINulls DatabaseOption = "ANSI_NULLS" DBOptANSIPadding DatabaseOption = "ANSI_PADDING" DBOptANSIWarnings DatabaseOption = "ANSI_WARNINGS" DBOptArithAbort DatabaseOption = "ARITHABORT" DBOptConcatNullYieldsNull DatabaseOption = "CONCAT_NULL_YIELDS_NULL" DBOptNumericRoundAbort DatabaseOption = "NUMERIC_ROUNDABORT" DBOptQuotedIdentifier DatabaseOption = "QUOTED_IDENTIFIER" DBOptRecursiveTriggers DatabaseOption = "RECURSIVE_TRIGGERS" DBOptCursorCloseOnCommit DatabaseOption = "CURSOR_CLOSE_ON_COMMIT" DBOptCursorDefault DatabaseOption = "CURSOR_DEFAULT" DBOptTrustworthy DatabaseOption = "TRUSTWORTHY" DBOptPageVerify DatabaseOption = "PAGE_VERIFY" DBOptContainment DatabaseOption = "CONTAINMENT" DBOptSnapshotIsolation DatabaseOption = "ALLOW_SNAPSHOT_ISOLATION" DBOptReadCommittedSnapshot DatabaseOption = "READ_COMMITTED_SNAPSHOT" )
type DatabaseOptions ¶ added in v0.0.4
type DatabaseOptions struct {
Owner string
PageVerify string // e.g. "CHECKSUM", "TORN_PAGE_DETECTION", "NONE"
UserAccess string // "MULTI_USER", "SINGLE_USER", "RESTRICTED_USER"
Containment string // "NONE", "PARTIAL"
DefaultCursor string // "LOCAL" or "GLOBAL"
SnapshotIsolation string // e.g. "OFF", "ON"
AutoClose bool
AutoShrink bool
AutoCreateStats bool
AutoUpdateStats bool
AutoUpdateStatsAsync bool
ANSINullDefault bool
ANSINulls bool
ANSIPadding bool
ANSIWarnings bool
ArithAbort bool
ConcatNullYieldsNull bool
NumericRoundAbort bool
QuotedIdentifier bool
RecursiveTriggers bool
CursorCloseOnCommit bool
ReadCommittedSnapshot bool
IsTrustworthy bool
IsBrokerEnabled bool
IsEncrypted bool
}
DatabaseOptions holds the ALTER DATABASE SET options and related flags from sys.databases that aren't already covered by Database's own cached fields (RecoveryModel, CompatibilityLevel, Collation, IsReadOnly).
type DatabasePermissionEntry ¶ added in v0.0.4
type DatabasePermissionEntry struct {
Principal string
PrincipalType string // e.g. "DATABASE_ROLE", "SQL_USER"
Grantor string
Permission string // e.g. "CONNECT", "CREATE TABLE", "ALTER"
State string // "GRANT", "GRANT_WITH_GRANT_OPTION", "DENY"
}
DatabasePermissionEntry is one GRANT/DENY entry recorded at database scope, as reported by sys.database_permissions — SSMS's Database Properties > Permissions page.
type DatabaseRecoveryStatus ¶ added in v0.0.10
type DatabaseRecoveryStatus struct {
// DatabaseName is the database this row describes.
DatabaseName string
// LastLogBackupLSN is the log sequence number of the last log backup, in
// the decimal form SQL Server stores it (numeric(25,0)), or "" when the
// column is NULL — which is the pseudo-simple state above.
LastLogBackupLSN string
// LogBackupChainStarted is LastLogBackupLSN != "", named for the question
// callers actually ask.
LogBackupChainStarted bool
}
DatabaseRecoveryStatus reports a database's place in its log backup chain, from sys.database_recovery_status.
The distinction it carries is not "has a backup" — it is whether the log backup chain has been started at all, which is what SQL Server tests before it will let a database join an availability group or a mirroring session. A database in the FULL recovery model that has never had a full backup is running in the so-called pseudo-simple model: no log chain exists, and ALTER AVAILABILITY GROUP ... ADD DATABASE fails with Msg 1475 ("might contain bulk logged changes that have not been backed up"). Switching a database to SIMPLE and back to FULL breaks the chain again.
type DatabaseRole ¶
type DatabaseRole struct {
Name string
ID int
IsFixedRole bool
Owner string
Members []string
SID []byte
CreateDate time.Time
ModifyDate time.Time
// contains filtered or unexported fields
}
DatabaseRole represents a database-level role.
func (*DatabaseRole) ChangeOwner ¶ added in v0.0.5
func (r *DatabaseRole) ChangeOwner(newOwner string) error
ChangeOwner transfers ownership of the database role to a new principal.
func (*DatabaseRole) ChangeOwnerContext ¶ added in v0.0.5
func (r *DatabaseRole) ChangeOwnerContext(ctx context.Context, newOwner string) error
ChangeOwnerContext is the context-aware variant of ChangeOwner.
func (*DatabaseRole) Drop ¶ added in v0.0.9
func (r *DatabaseRole) Drop() error
Drop drops this database role.
func (*DatabaseRole) DropContext ¶ added in v0.0.9
func (r *DatabaseRole) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
func (*DatabaseRole) Rename ¶ added in v0.0.5
func (r *DatabaseRole) Rename(newName string) error
Rename changes the database role's name.
func (*DatabaseRole) RenameContext ¶ added in v0.0.5
func (r *DatabaseRole) RenameContext(ctx context.Context, newName string) error
RenameContext is the context-aware variant of Rename.
type DatabaseScopedConfig ¶ added in v0.0.5
type DatabaseScopedConfig struct {
ID int
Name string
Value string
ValueForSecondary string
IsValueDefault bool
}
DatabaseScopedConfig mirrors one row of sys.database_scoped_configurations. Value and ValueForSecondary are the raw CAST(... AS NVARCHAR) text SQL Server reports for that option's sql_variant column — boolean-style options render as "0"/"1" this way, not "OFF"/"ON", while enum-style options like ELEVATE_ONLINE render their keyword directly (e.g. "OFF"). Callers that know an option is boolean should compare against "1", not "ON".
type DateCriterion ¶ added in v0.0.10
DateCriterion is one comparison against a creation date. Day's time of day is ignored.
type DateOp ¶ added in v0.0.10
type DateOp int
DateOp is one comparison a date criterion makes. All three work on whole calendar days: a creation date is a timestamp, and "created on the 20th" means the day, not midnight exactly.
type Dependency ¶ added in v0.0.4
type Dependency struct {
Schema string
Name string
TypeDesc string // e.g. "USER_TABLE", "VIEW", "SQL_STORED_PROCEDURE"
IsSchemaBound bool
}
Dependency is one edge in an object dependency graph, as reported by sys.sql_expression_dependencies — e.g. a view referencing a table, or a stored procedure referencing a function.
type DiskVolumeInfo ¶ added in v0.0.5
type DiskVolumeInfo struct {
// MountPoint is the drive letter (Windows) or mount path (Linux). Some
// hosts — e.g. a containerized Linux instance without a distinct OS
// volume — report this as empty.
MountPoint string
// VolumeName is the OS volume label, also sometimes empty.
VolumeName string
// SamplePath is one database file's path stored on this volume, for
// display when MountPoint and VolumeName are both empty.
SamplePath string
TotalMB float64
AvailableMB float64
}
DiskVolumeInfo describes free/total space for one storage volume backing at least one of the server's database files, as reported by sys.dm_os_volume_stats — a DMV SQL Server exposes identically on Windows and Linux, so this is usable regardless of the host OS.
type EffectivePermission ¶ added in v0.0.8
type EffectivePermission struct {
// Entity is the securable the permission applies to, as
// fn_my_permissions names it — "database", "server", or the
// schema-qualified object name.
Entity string
// Subentity is the column name for a column-level permission, empty
// otherwise. Asking about an object reports both: the object-level rows
// with an empty Subentity, then one row per column that carries a
// column-level permission of its own.
Subentity string
// Permission is the permission name, e.g. "SELECT", "VIEW DEFINITION".
Permission string
}
EffectivePermission is one permission a principal effectively holds on a securable, as reported by fn_my_permissions. Unlike a PermissionEntry it is not an explicit GRANT/DENY row: role membership, ownership, and permissions inherited from a wider scope (a schema grant covering a table, CONTROL implying everything below it) are all already resolved into it, and anything DENY takes away is simply absent.
type EndpointSpec ¶ added in v0.0.9
type EndpointSpec struct {
// Name is the endpoint's name. Required; it is arbitrary and purely local
// — replicas address each other by URL, never by endpoint name.
Name string
// Port is the TCP port to listen on. Zero means 5022, the conventional
// database mirroring port.
Port int
// Role is ALL, PARTNER or WITNESS. Empty means ALL, which is what an
// availability group replica needs.
Role string
// Authentication is the AUTHENTICATION clause — WINDOWS NEGOTIATE,
// WINDOWS KERBEROS, CERTIFICATE <name>, and so on. Empty means WINDOWS
// NEGOTIATE.
//
// Passed through as written, because the clause is a small grammar rather
// than one keyword ("CERTIFICATE x", "WINDOWS NEGOTIATE CERTIFICATE x").
// Instances with no domain in common — the usual Linux case — need a
// certificate here, and the certificate has to already exist and have been
// exchanged with every other replica.
Authentication string
// Encryption is the ENCRYPTION clause's state: REQUIRED, SUPPORTED or
// DISABLED. Empty means REQUIRED.
Encryption string
// EncryptionAlgorithm is the ALGORITHM sub-clause. Empty omits it, leaving
// the server's default; AES is the only sensible value on any supported
// version.
EncryptionAlgorithm string
}
EndpointSpec describes a database mirroring endpoint to create.
type ErrorLogEntry ¶
type ErrorLogEntry struct {
// LogDate is Date rendered as RFC 3339, kept for compatibility with
// callers written before Date existed.
LogDate string
// Process is the SQL Server log's ProcessInfo column, empty on an Agent
// log entry.
Process string
Text string
// Date is the entry's timestamp. The log stores no time zone, so this
// is the server's local wall clock carried in UTC.
Date time.Time
// ErrorLevel is the Agent log's severity column, 0 on a SQL Server log
// entry.
ErrorLevel int
}
ErrorLogEntry represents one row returned by xp_readerrorlog.
The middle column differs by log family, so only one of Process and ErrorLevel is meaningful for a given entry: the SQL Server log reports a ProcessInfo string ("Server", "spid9s"), the Agent log an integer severity. See Source for the one that applies.
func (*ErrorLogEntry) Source ¶ added in v0.0.9
func (e *ErrorLogEntry) Source() string
Source returns whichever of Process and ErrorLevel the entry's log family populated — the value to show in a "Source" column that spans both.
type ErrorLogFile ¶ added in v0.0.9
type ErrorLogFile struct {
// Number is the archive number — 0 for the current log, 1 for the most
// recently archived one, and so on. It is what ReadLog takes.
Number int
// Date is the last-written timestamp exactly as the server formatted it,
// kept because that formatting follows the server's locale and is the
// only thing to display when LastWritten couldn't be parsed.
Date string
// LastWritten is Date parsed, or the zero time if the server's format
// wasn't one of the known ones.
LastWritten time.Time
// SizeBytes is the log file's size on disk.
SizeBytes int64
}
ErrorLogFile is one log file reported by sp_enumerrorlogs: the current log plus however many archives the instance is configured to keep.
type ErrorLogType ¶ added in v0.0.9
type ErrorLogType int
ErrorLogType selects which of the two log families a read or an enumeration addresses. The values are the log-type argument xp_readerrorlog and sp_enumerrorlogs themselves take, so they can be passed straight through.
const ( // ErrorLogSQLServer is the SQL Server error log (ERRORLOG, ERRORLOG.1, …). ErrorLogSQLServer ErrorLogType = 1 // ErrorLogAgent is the SQL Server Agent error log (SQLAGENT.OUT, // SQLAGENT.1, …). ErrorLogAgent ErrorLogType = 2 )
func (ErrorLogType) String ¶ added in v0.0.9
func (t ErrorLogType) String() string
String names the log family for display.
type ExecutionPlan ¶ added in v0.0.4
type ExecutionPlan struct {
// XML is the last plan in All, in SQL Server's "Showplan XML" format —
// the same document SSMS parses to draw its graphical plan.
XML string
// All holds every captured plan document, one per statement, in the
// order the server returned them. Never empty on a successful capture.
All []string
}
ExecutionPlan holds the execution plans captured for one batch.
A batch of several statements yields several plan documents, not one: under SET SHOWPLAN_XML the server returns one row per statement, and under SET STATISTICS XML one extra result set per statement. All holds every one of them, in the order the server produced them; XML is the *last*, which is what this type returned when it held a single string and is kept for callers written against that. A caller that means "the plan for the batch" wants All.
type ExtendedProperty ¶
ExtendedProperty mirrors a row from sys.extended_properties.
type ExtendedPropertyLevel ¶
type ExtendedPropertyLevel struct {
Level0Type string // e.g. "SCHEMA"
Level0Name string
Level1Type string // e.g. "TABLE"
Level1Name string
Level2Type string // e.g. "COLUMN"
Level2Name string
}
ExtendedPropertyLevel identifies the object level for an extended property.
type FileGroup ¶
type FileGroup struct {
Name string
IsDefault bool
IsReadOnly bool
Files []DatabaseFile
}
FileGroup represents a SQL Server filegroup.
type FileModify ¶ added in v0.0.4
type FileModify struct {
NewName string
SizeKB int64
GrowthKB int64
GrowthPercent int
// DisableGrowth turns autogrowth off (FILEGROWTH = 0), and takes
// precedence over GrowthKB/GrowthPercent.
//
// It is a separate field because this struct's zero value means "leave
// this property alone", so GrowthKB = 0 cannot ask for FILEGROWTH = 0 —
// the one that omits the clause and the one that disables growth are
// the same value. Without it a UI whose growth control bottoms out at
// zero produces an ALTER with no FILEGROWTH clause, and if nothing else
// on the file changed, buildAlterFileStatement returns "" and
// AlterFileContext returns nil: an Apply that reports success and did
// nothing.
DisableGrowth bool
MaxSizeKB int64 // -1 = UNLIMITED
}
FileModify holds the fields to change on an existing file via AlterFile. Zero-valued fields are left unchanged; NewName renames the file.
type FileSystemEntry ¶ added in v0.0.9
type FileSystemEntry struct {
Name string
FullPath string
IsDirectory bool
Size int64
LastModified time.Time
}
FileSystemEntry is one file or directory in a server-side directory listing. Size and LastModified are zero for entries the server reports without them (the xp_dirtree fallback on pre-2017 instances).
type FixedDrive ¶ added in v0.0.9
type FixedDrive struct {
Name string // "C:\" on Windows, "/" on Linux
Type string // e.g. "DRIVE_FIXED"
FreeSpaceBytes int64
}
FixedDrive is one fixed drive (a volume, on Windows) visible to the SQL Server host. On Linux the server reports the single root filesystem.
type ForeignKey ¶
type ForeignKey struct {
Name string
Columns []string
ReferencedTable string
ReferencedSchema string
ReferencedColumns []string
DeleteAction string // NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT
UpdateAction string
IsDisabled bool
IsNotForReplication bool
}
ForeignKey mirrors Microsoft.SqlServer.Management.Smo.ForeignKey.
type Index ¶
type Index struct {
Name string
IndexID int
Type IndexType
IsClustered bool
IsUnique bool
IsPrimaryKey bool
IsUniqueConstraint bool
IsDisabled bool
FillFactor int
IsPadded bool
IgnoreDupKey bool
AllowRowLocks bool
AllowPageLocks bool
DataCompression string
KeyColumns []IndexColumn
IncludedColumns []IndexColumn
FilterDefinition string
DataSpace DataSpace
}
Index mirrors Microsoft.SqlServer.Management.Smo.Index.
func (*Index) DisableContext ¶
DisableContext is the context-aware variant of Disable.
func (*Index) DropContext ¶
DropContext is the context-aware variant of Drop.
func (*Index) EnableContext ¶ added in v0.0.6
EnableContext is the context-aware variant of Enable.
func (*Index) Fragmentation ¶ added in v0.0.6
func (idx *Index) Fragmentation(t *Table, mode string) (*IndexFragmentation, error)
Fragmentation returns fragmentation and page-density statistics for this index alone — the single-index analog of Table.FragmentationStats, used by Index Properties' Fragmentation page. mode follows Table.FragmentationStats's (LIMITED, SAMPLED, or DETAILED); page density is only populated by SAMPLED or DETAILED (LIMITED always reports 0, same as the underlying DMV).
func (*Index) FragmentationContext ¶ added in v0.0.6
func (idx *Index) FragmentationContext(ctx context.Context, t *Table, mode string) (*IndexFragmentation, error)
FragmentationContext is the context-aware variant of Fragmentation.
func (*Index) Rebuild ¶
Rebuild rebuilds the index (ALTER INDEX ... REBUILD). Pass fillFactor=0 to keep the existing fill factor.
func (*Index) RebuildContext ¶
RebuildContext is the context-aware variant of Rebuild.
func (*Index) RebuildWithOptions ¶ added in v0.0.6
func (idx *Index) RebuildWithOptions(t *Table, fillFactor int, padIndex bool, dataCompression string) error
RebuildWithOptions rebuilds the index with an explicit fill factor, pad index setting, and data compression (ALTER INDEX ... REBUILD WITH) — the only way to change these three, since none is a plain ALTER INDEX SET option. Pass dataCompression="" to leave compression unspecified (keeps the index's current setting).
func (*Index) RebuildWithOptionsContext ¶ added in v0.0.6
func (idx *Index) RebuildWithOptionsContext(ctx context.Context, t *Table, fillFactor int, padIndex bool, dataCompression string) error
RebuildWithOptionsContext is the context-aware variant of RebuildWithOptions.
func (*Index) Rename ¶ added in v0.0.6
Rename renames the index using sp_rename — also the mechanism for renaming a PRIMARY KEY or UNIQUE constraint, since its name is the backing index's name in sys.indexes.
func (*Index) RenameContext ¶ added in v0.0.6
RenameContext is the context-aware variant of Rename.
func (*Index) Reorganize ¶
Reorganize reorganizes the index (ALTER INDEX ... REORGANIZE).
func (*Index) ReorganizeContext ¶
ReorganizeContext is the context-aware variant of Reorganize.
func (*Index) SetIncludedColumns ¶ added in v0.0.6
SetIncludedColumns replaces the index's included (non-key) columns. Changing included columns isn't a plain ALTER — it requires recreating the index, so this reissues a full CREATE INDEX ... WITH (DROP_EXISTING = ON) from idx's own key columns, uniqueness, type, and filter, with columns as the new INCLUDE list.
func (*Index) SetIncludedColumnsContext ¶ added in v0.0.6
SetIncludedColumnsContext is the context-aware variant of SetIncludedColumns.
func (*Index) SetLockOptions ¶ added in v0.0.6
SetLockOptions applies just the lock-granularity SET options (ALTER INDEX ... SET (ALLOW_ROW_LOCKS = .., ALLOW_PAGE_LOCKS = ..)) — unlike SetOptions, this never touches IGNORE_DUP_KEY, which SQL Server rejects outright on an index backing a PRIMARY KEY or UNIQUE constraint ("Cannot use index option ignore_dup_key to alter index '...' as it enforces a primary or unique constraint").
func (*Index) SetLockOptionsContext ¶ added in v0.0.6
func (idx *Index) SetLockOptionsContext(ctx context.Context, t *Table, allowRowLocks, allowPageLocks bool) error
SetLockOptionsContext is the context-aware variant of SetLockOptions.
func (*Index) SetOptions ¶ added in v0.0.6
SetOptions applies the index's SET-able runtime options (ALTER INDEX ... SET). Fill factor, pad index, and data compression only take effect on a rebuild — see RebuildWithOptions for those.
func (*Index) SetOptionsContext ¶ added in v0.0.6
func (idx *Index) SetOptionsContext(ctx context.Context, t *Table, ignoreDupKey, allowRowLocks, allowPageLocks bool) error
SetOptionsContext is the context-aware variant of SetOptions.
func (*Index) StorageInfo ¶ added in v0.0.6
func (idx *Index) StorageInfo(t *Table) (*IndexStorageInfo, error)
StorageInfo returns filegroup/partitioning and space usage for this index.
func (*Index) StorageInfoContext ¶ added in v0.0.6
StorageInfoContext is the context-aware variant of StorageInfo.
func (*Index) UpdateStatistics ¶ added in v0.0.6
UpdateStatistics updates the statistics object tied to this index (UPDATE STATISTICS table (index) — every index has an implicit statistics object with the same name).
type IndexAllocationUnit ¶ added in v0.0.6
IndexAllocationUnit is one row of an index's allocation-unit space breakdown (IN_ROW_DATA, LOB_DATA, ROW_OVERFLOW_DATA).
type IndexColumn ¶
IndexColumn represents one column in an index.
type IndexColumnDef ¶
IndexColumnDef describes one key column for a new index.
type IndexFragmentation ¶
type IndexFragmentation struct {
IndexName string
IndexID int
AvgFragmentationPct float64
PageCount int64
FragmentCount int64
AvgPageSpaceUsedPct float64
}
IndexFragmentation holds fragmentation statistics for one index. AvgPageSpaceUsedPct is only populated when the DMV ran in SAMPLED or DETAILED mode (see Index.Fragmentation's mode parameter); Table.FragmentationStats's own LIMITED-mode query leaves it zero, matching the underlying DMV.
type IndexStorageInfo ¶ added in v0.0.6
type IndexStorageInfo struct {
FileGroup string
PartitionScheme string
PartitionColumn string
RowCount int64
UsedKB int64
ReservedKB int64
AvgRecordSize float64
Allocations []IndexAllocationUnit
}
IndexStorageInfo holds an index's filegroup/partitioning and space usage — SSMS's Index Properties > Storage page.
type IndexType ¶
type IndexType string
IndexType represents the type of an index.
const ( IndexTypeClustered IndexType = "CLUSTERED" IndexTypeNonClustered IndexType = "NONCLUSTERED" IndexTypeXML IndexType = "XML" IndexTypeSpatial IndexType = "SPATIAL" IndexTypeColumnStore IndexType = "COLUMNSTORE" IndexTypeClusteredColumnStore IndexType = "CLUSTERED COLUMNSTORE" )
The values match sys.indexes.type_desc, except IndexTypeColumnStore, which predates IndexTypeClusteredColumnStore and keeps its original spelling. A type_desc with no constant here is carried through verbatim (see Table.IndexesContext), so Type is never empty for an index that exists.
func (IndexType) IsColumnStore ¶ added in v0.0.7
IsColumnStore reports whether t is either columnstore index type.
type Job ¶
type Job struct {
JobID string
Name string
Description string
IsEnabled bool
Category string
OwnerLoginName string
DateCreated time.Time
DateModified time.Time
StartStepID int
DeleteLevel NotifyLevel
NotifyLevelEmail NotifyLevel
// NotifyEmailOperatorName is "" if no operator is configured to be
// emailed on job completion.
NotifyEmailOperatorName string
LastRunDate time.Time
LastRunOutcome JobOutcome
LastRunDuration time.Duration
NextRunDate time.Time
CurrentState JobState
// contains filtered or unexported fields
}
Job mirrors a row in msdb.dbo.sysjobs together with its latest activity.
func (*Job) AddSchedule ¶
func (j *Job) AddSchedule(req JobScheduleRequest) error
AddSchedule attaches a schedule to the job.
func (*Job) AddScheduleContext ¶
func (j *Job) AddScheduleContext(ctx context.Context, req JobScheduleRequest) error
AddScheduleContext is the context-aware variant of AddSchedule.
func (*Job) AddStep ¶
func (j *Job) AddStep(req JobStepRequest) error
AddStep adds a T-SQL or other subsystem step to the job.
func (*Job) AddStepContext ¶
func (j *Job) AddStepContext(ctx context.Context, req JobStepRequest) error
AddStepContext is the context-aware variant of AddStep.
func (*Job) AttachSchedule ¶ added in v0.0.6
AttachSchedule attaches an existing shared schedule to the job — as opposed to AddSchedule, which creates a brand-new schedule and attaches it in one step.
func (*Job) AttachScheduleContext ¶ added in v0.0.6
AttachScheduleContext is the context-aware variant of AttachSchedule.
func (*Job) DetachSchedule ¶ added in v0.0.6
DetachSchedule detaches a schedule from the job without deleting the schedule itself (it may still be shared by other jobs).
func (*Job) DetachScheduleContext ¶ added in v0.0.6
DetachScheduleContext is the context-aware variant of DetachSchedule.
func (*Job) DisableContext ¶ added in v0.0.6
DisableContext is the context-aware variant of Disable.
func (*Job) DropContext ¶
DropContext is the context-aware variant of Drop.
func (*Job) EnableContext ¶ added in v0.0.6
EnableContext is the context-aware variant of Enable.
func (*Job) History ¶
func (j *Job) History(limit int) ([]*JobHistoryEntry, error)
History returns the execution history (most recent first). Pass limit=0 to use the default of 100 rows.
func (*Job) HistoryContext ¶
HistoryContext is the context-aware variant of History.
func (*Job) HistorySeq ¶ added in v0.0.6
HistorySeq returns an iterator over this job's most recent history entries, up to limit.
func (*Job) InsertStep ¶ added in v0.0.10
func (j *Job) InsertStep(req JobStepRequest, stepID int) error
InsertStep adds a step at position stepID, renumbering the steps at and after it, rather than appending.
The renumbering is msdb's, and it carries every other step's "go to step N" reference with it — verified against SQL Server 2025. sp_delete_jobstep is not symmetrical about this: it clears a reference to a step at or after the one deleted instead of following it, which is why ReorderSteps repairs references itself.
func (*Job) InsertStepContext ¶ added in v0.0.10
InsertStepContext is the context-aware variant of InsertStep.
func (*Job) MoveStep ¶ added in v0.0.10
MoveStep moves the step at position stepID to position newStepID, renumbering the steps in between. See MoveStepContext.
func (*Job) MoveStepContext ¶ added in v0.0.10
MoveStepContext moves one step to another position, which is what "move up" and "move down" in a job's step list amount to.
msdb has no procedure that renumbers a step in place, so the move is a delete followed by an insert at the target position — which is why the step's whole definition has to survive the round trip, and why JobStep and JobStepRequest model every sysjobsteps column that sp_add_jobstep can set rather than the handful a step form edits.
"Go to step N" references follow the steps they name. sp_add_jobstep remaps them on insert, but sp_delete_jobstep does not — it resets a reference to a step at or after the deleted one to "quit with success", silently (verified against SQL Server 2025). So every reference is written back afterwards from the pre-move reading, mapped through the move. A reference that pointed at the moved step still points at it; one that pointed at a step the move shifted follows that step.
func (*Job) RenameContext ¶ added in v0.0.6
RenameContext is the context-aware variant of Rename.
func (*Job) ReorderSteps ¶ added in v0.0.10
ReorderSteps puts the job's steps into the given order. See ReorderStepsContext.
func (*Job) ReorderStepsContext ¶ added in v0.0.10
ReorderStepsContext rewrites the job's step order. order is given the current number of steps and returns the current step ids in the sequence they should end up in — every id exactly once.
The reorder is realised as delete-and-insert per step that has to move, fewest first, and every "go to step N" reference is rewritten afterwards through the composed mapping. See MoveStepContext for why both halves are necessary.
The job must have been read with JobByName: the step listing is by job_id, which a bare Server.Job handle does not carry.
func (*Job) ScheduleSeq ¶ added in v0.0.6
ScheduleSeq returns an iterator over the schedules attached to this job.
func (*Job) SchedulesContext ¶ added in v0.0.6
SchedulesContext is the context-aware variant of Schedules.
func (*Job) SetCategory ¶ added in v0.0.6
SetCategory reassigns the job's category.
func (*Job) SetCategoryContext ¶ added in v0.0.6
SetCategoryContext is the context-aware variant of SetCategory.
func (*Job) SetDeleteLevel ¶ added in v0.0.6
func (j *Job) SetDeleteLevel(level NotifyLevel) error
SetDeleteLevel sets the job's automatic-delete condition.
func (*Job) SetDeleteLevelContext ¶ added in v0.0.6
func (j *Job) SetDeleteLevelContext(ctx context.Context, level NotifyLevel) error
SetDeleteLevelContext is the context-aware variant of SetDeleteLevel.
func (*Job) SetDescription ¶ added in v0.0.6
SetDescription changes the job's description.
func (*Job) SetDescriptionContext ¶ added in v0.0.6
SetDescriptionContext is the context-aware variant of SetDescription.
func (*Job) SetEmailNotify ¶ added in v0.0.6
func (j *Job) SetEmailNotify(operatorName string, level NotifyLevel) error
SetEmailNotify sets which operator is emailed on job completion, and under what condition. operatorName == "" leaves the currently configured operator unchanged (SQL Server has no documented "clear to none" value for sp_update_job's @notify_email_operator_name; pair with NotifyNever to stop emailing without needing to clear it).
func (*Job) SetEmailNotifyContext ¶ added in v0.0.6
func (j *Job) SetEmailNotifyContext(ctx context.Context, operatorName string, level NotifyLevel) error
SetEmailNotifyContext is the context-aware variant of SetEmailNotify.
func (*Job) SetOwnerContext ¶ added in v0.0.6
SetOwnerContext is the context-aware variant of SetOwner.
func (*Job) SetStartStep ¶ added in v0.0.6
SetStartStep changes which step the job begins execution from.
func (*Job) SetStartStepContext ¶ added in v0.0.6
SetStartStepContext is the context-aware variant of SetStartStep.
func (*Job) StartContext ¶
StartContext is the context-aware variant of Start.
func (*Job) StepSeq ¶ added in v0.0.6
StepSeq returns an iterator over a job's steps, in step_id order.
func (*Job) StepsContext ¶
StepsContext is the context-aware variant of Steps.
type JobHistoryEntry ¶
type JobHistoryEntry struct {
// JobName is only populated by Server.JobHistory (the cross-job
// history query); it's left "" by Job.History, whose caller already
// knows which job it asked about.
JobName string
RunDate time.Time
Duration time.Duration
Outcome JobOutcome
Message string
StepID int
StepName string
}
JobHistoryEntry represents one row from msdb.dbo.sysjobhistory.
type JobNotificationRef ¶ added in v0.0.6
type JobNotificationRef struct {
JobName string
Level NotifyLevel
}
JobNotificationRef describes one job configured to email an operator on completion.
type JobOutcome ¶
type JobOutcome int
JobOutcome represents the last run outcome for a job or step.
const ( JobOutcomeFailed JobOutcome = 0 JobOutcomeSucceeded JobOutcome = 1 JobOutcomeRetried JobOutcome = 2 JobOutcomeCancelled JobOutcome = 3 JobOutcomeUnknown JobOutcome = 5 )
type JobScheduleRequest ¶
type JobScheduleRequest struct {
Name string
Enabled bool
// FreqType: 1=once, 4=daily, 8=weekly, 16=monthly, 64=when agent starts.
FreqType int
FreqInterval int
// FreqSubdayType: 1=once, 2=seconds, 4=minutes, 8=hours.
FreqSubdayType int
FreqSubdayInterval int
// ActiveStartTime and ActiveEndTime are HHMMSS integers, e.g. 23000 = 02:30:00.
ActiveStartTime int
ActiveEndTime int
}
JobScheduleRequest describes a schedule to attach to a job.
type JobState ¶
type JobState int
JobState mirrors the current_execution_status values in msdb.dbo.sysjobactivity.
type JobStep ¶
type JobStep struct {
StepID int
Name string
Subsystem string // "TSQL", "CmdExec", "SSIS", etc.
Command string
// Database is only meaningful for TSQL steps.
Database string
OnSuccessAction int
// OnSuccessStepID is the target step_id when OnSuccessAction is
// "go to step N" (4); otherwise unused.
OnSuccessStepID int
OnFailAction int
// OnFailStepID is the target step_id when OnFailAction is "go to
// step N" (4); otherwise unused.
OnFailStepID int
LastRunOutcome JobOutcome
// LastRunDate is when the step last ran, from sysjobsteps'
// last_run_date/last_run_time integer pair. Zero when the step has never
// run — test it with IsZero(), not against a sentinel date.
LastRunDate time.Time
// LastRunDuration is sysjobsteps.last_run_duration verbatim: an HHMMSS
// integer, not a count of seconds (10230 is 1h 02m 30s). LastRunElapsed
// is the same value decoded, and is what display code should use.
LastRunDuration int
LastRunElapsed time.Duration
RetryAttempts int
RetryInterval int
OutputFileName string
// Flags is the raw sysjobsteps.flags bitmask (append-to-output-file,
// log-to-table, include-step-output-in-history, ...). See Microsoft's
// sp_add_jobstep documentation for bit meanings; gosmo round-trips it
// as-is rather than decoding it into named booleans.
Flags int
// ProxyName is the proxy account the step runs under, or "" for none
// (the Agent service account). Resolved from sysjobsteps.proxy_id.
ProxyName string
// AdditionalParameters is sysjobsteps.additional_parameters, used by
// some subsystems and left empty by TSQL steps.
AdditionalParameters string
// CmdExecSuccessCode is the process exit code a CmdExec step treats as
// success. Zero for every other subsystem, and also the CmdExec default.
CmdExecSuccessCode int
// Server is sysjobsteps.server, the target server for a replication or
// analysis-services step; "" for the common case.
Server string
// DatabaseUserName is the user a TSQL step impersonates, or "" to run as
// the job owner's mapping.
DatabaseUserName string
// OSRunPriority is the process priority for a CmdExec step.
OSRunPriority int
// contains filtered or unexported fields
}
JobStep represents one step of an agent job.
func (*JobStep) DeleteContext ¶ added in v0.0.6
DeleteContext is the context-aware variant of Delete.
func (*JobStep) SetFlow ¶ added in v0.0.10
SetFlow changes only the step's control flow — what happens after it succeeds or fails — leaving its command, proxy, flags and everything else untouched.
Every other parameter is omitted, which sp_update_jobstep reads as "leave alone". That is what makes this usable for repairing references after a reorder, where rewriting the whole definition would be both wasteful and a chance to lose a column the request does not model.
func (*JobStep) SetFlowContext ¶ added in v0.0.10
func (s *JobStep) SetFlowContext(ctx context.Context, onSuccessAction, onSuccessStepID, onFailAction, onFailStepID int) error
SetFlowContext is the context-aware variant of SetFlow.
func (*JobStep) Update ¶ added in v0.0.6
func (s *JobStep) Update(req JobStepRequest) error
Update replaces the step's definition via sp_update_jobstep.
func (*JobStep) UpdateContext ¶ added in v0.0.6
func (s *JobStep) UpdateContext(ctx context.Context, req JobStepRequest) error
UpdateContext is the context-aware variant of Update.
type JobStepRequest ¶
type JobStepRequest struct {
Name string
Subsystem string // "TSQL" is the most common value
Command string
// Database is only used for TSQL steps.
//
// Empty means "leave the step's own database alone" on an update, not
// "clear it": sp_update_jobstep accepts N” without error and changes
// nothing, so JobStep.UpdateContext omits @database_name entirely rather
// than sending a value that would be silently ignored. On AddStep an
// empty value likewise sends no @database_name, and the server applies
// its default. There is no way to null the column through this type,
// because msdb offers none.
Database string
// OnSuccessAction: 1=quit success, 2=quit fail, 3=go to next step, 4=go to step N.
OnSuccessAction int
// OnSuccessStepID is the target step_id when OnSuccessAction is 4.
OnSuccessStepID int
OnFailAction int
// OnFailStepID is the target step_id when OnFailAction is 4.
OnFailStepID int
RetryAttempts int
// RetryInterval is in minutes.
RetryInterval int
// OutputFileName is sent on every update, empty or not — unlike
// Database, whose empty value means "keep". @output_file_name does
// honour N”: it nulls the column, so blanking this field is how a
// caller's form clears a step's output file. Two string fields of this
// struct therefore read an empty value differently, because msdb does.
OutputFileName string
// Flags is the raw sysjobsteps.flags bitmask.
//
// This field and the six below it are sent by AddStep and InsertStep,
// which create a row and so decide every column of it. UpdateContext
// deliberately does not send them: an omitted sp_update_jobstep
// parameter means "leave alone", which is what an edit of the fields a
// step form owns should do to a step's proxy, flags and run-as user.
Flags int
// ProxyName, AdditionalParameters, Server and DatabaseUserName are sent
// only when non-empty: msdb reads an omitted parameter as "leave alone"
// on an update and "use the default" on an add, while N” for a proxy or
// a user name is an error rather than a clear.
ProxyName string
AdditionalParameters string
Server string
DatabaseUserName string
// CmdExecSuccessCode and OSRunPriority are sent verbatim, zero included:
// zero is msdb's own default for both, so it cannot be told from unset
// and there is nothing to lose by sending it.
CmdExecSuccessCode int
OSRunPriority int
}
JobStepRequest describes a step to add to, or replace the definition of (see JobStep.Update), a job.
type KerberosOptions ¶ added in v0.0.4
type KerberosOptions struct {
// ConfigFile is the path to krb5.conf. Defaults to $KRB5_CONFIG then
// /etc/krb5.conf. The file must exist for any Kerberos login.
ConfigFile string
// CredCacheFile is the path to a credential cache produced by "kinit".
// Defaults to $KRB5CCNAME. Use this for single sign-on.
CredCacheFile string
// KeytabFile is the path to a keytab holding the client's long-term key,
// for unattended logins. Requires User and Realm. Defaults to
// $KRB5_KTNAME or the configured default client keytab.
KeytabFile string
// Realm is the Kerberos realm, e.g. "CONTOSO.COM". When empty it is
// taken from a "user@REALM" User, then from the krb5.conf default realm.
Realm string
// DNSLookupKDC, when non-nil, overrides whether KDCs are located via DNS
// SRV records. The driver defaults to true.
DNSLookupKDC *bool
// UDPPreferenceLimit caps the message size sent over UDP before TCP is
// used. Zero leaves the driver default (1, i.e. effectively always TCP).
UDPPreferenceLimit int
}
KerberosOptions configures Kerberos authentication for AuthWindows on non-Windows hosts (and on Windows when set explicitly, in preference to native SSPI). Every field is optional: with all left zero the driver uses the ambient Kerberos setup — /etc/krb5.conf (or $KRB5_CONFIG) and the credential cache from a prior "kinit" ($KRB5CCNAME or the default cache) — which is the usual single-sign-on flow on a domain-joined Linux host.
The three credential sources are mutually exclusive and tried in this order of precedence by the driver: an explicit KeytabFile (with User and Realm), then a CredCacheFile, then User + Password (with Realm). When none is set, the credential cache is discovered from the environment.
type Language ¶ added in v0.0.4
Language mirrors a row from sys.syslanguages — used to populate the server's "Default language" and a Login's "Default language" dropdowns.
type LinkedServer ¶
type LinkedServer struct {
Name string
Product string
Provider string
DataSource string
IsRemote bool
}
LinkedServer represents a linked server definition.
type LogSearch ¶ added in v0.0.10
LogSearch narrows a log read at the server. Every field is optional, and a zero LogSearch reads the whole file — what ReadLog does.
These are xp_readerrorlog's own arguments 3-6, with its semantics: Text1 and Text2 are case-insensitive substrings AND-ed together (not two alternatives), and From/To bound the entry timestamp. Filtering here rather than in the caller matters for the current log on a busy instance, which runs to tens of thousands of entries.
type Login ¶
type Login struct {
Name string
SID []byte
// LoginType is the login's type_desc: "SQL_LOGIN", "WINDOWS_LOGIN",
// "WINDOWS_GROUP", "EXTERNAL_LOGIN", "EXTERNAL_GROUP",
// "CERTIFICATE_MAPPED_LOGIN" or "ASYMMETRIC_KEY_MAPPED_LOGIN".
LoginType string
IsDisabled bool
DefaultDatabase string
CreateDate time.Time
ModifyDate time.Time
// MappedObject is the master certificate or asymmetric key a
// CERTIFICATE_MAPPED_LOGIN / ASYMMETRIC_KEY_MAPPED_LOGIN maps to. It is
// not read with the login — the name lives in master, not in
// sys.server_principals — so it is empty until ResolveMapping fills it.
MappedObject string
// contains filtered or unexported fields
}
Login represents a SQL Server server-level login.
func (*Login) AddServerRoleMember ¶
AddServerRoleMember adds this login to a server role.
func (*Login) AddServerRoleMemberContext ¶
AddServerRoleMemberContext is the context-aware variant of AddServerRoleMember.
func (*Login) ChangePassword ¶
ChangePassword changes the login's password.
func (*Login) ChangePasswordContext ¶
ChangePasswordContext changes the login's password.
Security: the password is quoted via nStringLiteral (N'...', doubling any embedded quote) rather than interpolated raw. HASHED is deliberately not used — it tells SQL Server the value is already one of its own password-hash formats, not cleartext, so passing a hex encoding of the cleartext under HASHED either fails outright or creates a login nothing can ever authenticate as.
func (*Login) ChangePasswordWithOptions ¶ added in v0.0.4
ChangePasswordWithOptions changes the login's password with the same quoted-literal encoding ChangePassword uses, plus MUST_CHANGE (force a password change at next login) and UNLOCK (clear a lockout).
func (*Login) ChangePasswordWithOptionsContext ¶ added in v0.0.4
func (l *Login) ChangePasswordWithOptionsContext(ctx context.Context, newPassword string, mustChange, unlock bool) error
ChangePasswordWithOptionsContext is the context-aware variant of ChangePasswordWithOptions.
func (*Login) Details ¶ added in v0.0.4
func (l *Login) Details() (*LoginDetails, error)
Details returns the login's password-policy and status information.
func (*Login) DetailsContext ¶ added in v0.0.4
func (l *Login) DetailsContext(ctx context.Context) (*LoginDetails, error)
DetailsContext is the context-aware variant of Details.
func (*Login) DisableContext ¶
DisableContext is the context-aware variant of Disable.
func (*Login) DropContext ¶ added in v0.0.6
DropContext is the context-aware variant of Drop.
func (*Login) EnableContext ¶
EnableContext is the context-aware variant of Enable.
func (*Login) MapCredential ¶ added in v0.0.4
MapCredential maps a server credential to the login.
func (*Login) MapCredentialContext ¶ added in v0.0.4
MapCredentialContext is the context-aware variant of MapCredential.
func (*Login) MapToDatabase ¶ added in v0.0.4
MapToDatabase creates a user for this login in the named database (CREATE USER ... FOR LOGIN).
func (*Login) MapToDatabaseContext ¶ added in v0.0.4
func (l *Login) MapToDatabaseContext(ctx context.Context, dbName, userName, defaultSchema string) error
MapToDatabaseContext is the context-aware variant of MapToDatabase.
func (*Login) RemoveServerRoleMember ¶
RemoveServerRoleMember removes this login from a server role.
func (*Login) RemoveServerRoleMemberContext ¶
RemoveServerRoleMemberContext is the context-aware variant of RemoveServerRoleMember.
func (*Login) RenameContext ¶ added in v0.0.4
RenameContext is the context-aware variant of Rename.
func (*Login) ResolveMapping ¶ added in v0.0.10
ResolveMapping looks up the certificate or asymmetric key this login maps to and stores its name in MappedObject.
func (*Login) ResolveMappingContext ¶ added in v0.0.10
ResolveMappingContext is the context-aware variant of ResolveMapping.
It is a no-op for every login type but CERTIFICATE_MAPPED_LOGIN and ASYMMETRIC_KEY_MAPPED_LOGIN. The lookup is by SID against master, where a login-mapped certificate or asymmetric key must live, and names master explicitly because the connection may be in any database. MappedObject is left empty, without an error, when nothing matches — the mapped object can have been dropped out from under the login.
func (*Login) SetDefaultDatabase ¶ added in v0.0.4
SetDefaultDatabase changes the login's default database.
func (*Login) SetDefaultDatabaseContext ¶ added in v0.0.4
SetDefaultDatabaseContext is the context-aware variant of SetDefaultDatabase.
func (*Login) SetDefaultLanguage ¶ added in v0.0.4
SetDefaultLanguage changes the login's default language.
func (*Login) SetDefaultLanguageContext ¶ added in v0.0.4
SetDefaultLanguageContext is the context-aware variant of SetDefaultLanguage.
func (*Login) SetPasswordPolicy ¶ added in v0.0.4
SetPasswordPolicy sets the login's CHECK_POLICY and CHECK_EXPIRATION flags. SQL Server rejects checkExpiration=true with checkPolicy=false — surfaced as the returned error, not pre-validated here.
func (*Login) SetPasswordPolicyContext ¶ added in v0.0.4
func (l *Login) SetPasswordPolicyContext(ctx context.Context, checkPolicy, checkExpiration bool) error
SetPasswordPolicyContext is the context-aware variant of SetPasswordPolicy.
func (*Login) UnmapCredential ¶ added in v0.0.4
UnmapCredential removes a credential mapping from the login.
func (*Login) UnmapCredentialContext ¶ added in v0.0.4
UnmapCredentialContext is the context-aware variant of UnmapCredential.
func (*Login) UnmapFromDatabase ¶ added in v0.0.4
UnmapFromDatabase drops this login's mapped user in the named database.
func (*Login) UnmapFromDatabaseContext ¶ added in v0.0.4
UnmapFromDatabaseContext is the context-aware variant of UnmapFromDatabase.
func (*Login) UserMappingSeq ¶ added in v0.0.4
UserMappingSeq returns an iterator over every database this login is mapped into.
func (*Login) UserMappings ¶ added in v0.0.4
func (l *Login) UserMappings() ([]*LoginUserMapping, error)
UserMappings returns every database this login has a mapped user in. Only mapped databases are included — combine with Server.Databases to build a full "all databases, mapped or not" view. Databases that are offline, or that the login can't currently reach, are skipped rather than failing the whole scan (SSMS's own User Mapping page behaves the same way). A cancelled context is not skipped — it ends the scan and is returned.
The skip covers a database whose query never opened. Once its rows are being read, a failure ends the scan with an error instead: those rows are already in the result, so skipping would return a short list and call it success.
func (*Login) UserMappingsContext ¶ added in v0.0.4
func (l *Login) UserMappingsContext(ctx context.Context) ([]*LoginUserMapping, error)
UserMappingsContext is the context-aware variant of UserMappings.
type LoginDetails ¶ added in v0.0.4
type LoginDetails struct {
IsLocked bool
IsExpired bool
MustChangePassword bool
IsPolicyChecked bool
IsExpirationChecked bool
PasswordLastSet time.Time
// LastLogin is best-effort: it reflects the most recent session found
// in sys.dm_exec_sessions, which only holds currently-connected (or
// very recently disconnected) sessions, not full login history. It is
// the zero Time if no matching session is currently visible.
LastLogin time.Time
BadPasswordCount int
// BadPasswordTime is the last failed-login attempt time, or the zero
// Time if none is recorded.
BadPasswordTime time.Time
DefaultLanguage string
CredentialName string
// ConnectSQLState is "GRANT", "DENY", or "" (default/unset) for the
// login's explicit CONNECT SQL server permission.
ConnectSQLState string
}
LoginDetails holds the login's password-policy and status fields — SSMS's Login Properties > Status page (plus the policy checkboxes and credential mapping shown on the General page). Windows logins have no password policy; those fields read as their zero value rather than erroring, since LOGINPROPERTY simply returns NULL for them.
type LoginSource ¶ added in v0.0.10
type LoginSource int
LoginSource names what a new login authenticates from — the FROM clause of CREATE LOGIN, or WITH PASSWORD for a SQL login.
const ( // LoginSourceAuto resolves from the password CreateLogin is given: empty // means a Windows login, non-empty a SQL login. It is the zero value, so // a CreateLoginOptions written before LoginSource existed behaves exactly // as it did. LoginSourceAuto LoginSource = iota // LoginSourceSQL is a SQL Server login (WITH PASSWORD). LoginSourceSQL // LoginSourceWindows is a Windows user or group login (FROM WINDOWS). LoginSourceWindows // LoginSourceExternalProvider is a Microsoft Entra ID (Azure AD) login // (FROM EXTERNAL PROVIDER) — SQL Server 2022 and later, Azure SQL // Managed Instance, and Azure SQL Database. LoginSourceExternalProvider // LoginSourceCertificate maps the login to a certificate in master // (FROM CERTIFICATE). Nothing authenticates as such a login; it exists // to hold permissions for code signed by the certificate. LoginSourceCertificate // LoginSourceAsymmetricKey maps the login to an asymmetric key in master // (FROM ASYMMETRIC KEY), the asymmetric-key counterpart of // LoginSourceCertificate. LoginSourceAsymmetricKey )
func (LoginSource) String ¶ added in v0.0.10
func (src LoginSource) String() string
String renders the source as the words used in error messages.
type LoginUserMapping ¶ added in v0.0.4
LoginUserMapping describes one database this login is mapped into — SSMS's Login Properties > User Mapping page.
type MailProfile ¶
MailProfile represents an msdb Database Mail profile.
type NotificationMethod ¶ added in v0.0.6
type NotificationMethod int
NotificationMethod is msdb's bitmask for how an operator is notified (sysnotifications.notification_method, and reused by sysalerts.include_event_description — see Alert.IncludeEventDescriptionIn).
const ( NotifyMethodEmail NotificationMethod = 1 NotifyMethodPager NotificationMethod = 2 NotifyMethodNetSend NotificationMethod = 4 )
func (NotificationMethod) String ¶ added in v0.0.6
func (m NotificationMethod) String() string
String renders the method bitmask as e.g. "Email, Pager".
type NotifyLevel ¶ added in v0.0.6
type NotifyLevel int
NotifyLevel is the "when" condition for a job's email notification and its automatic-delete behavior — msdb's shared 0-3 encoding used by both sysjobs.notify_level_email and sysjobs.delete_level.
const ( NotifyNever NotifyLevel = 0 NotifyOnSuccess NotifyLevel = 1 NotifyOnFailure NotifyLevel = 2 NotifyOnComplete NotifyLevel = 3 )
type ObjectFilter ¶ added in v0.0.10
type ObjectFilter struct {
Name []TextCriterion
Schema []TextCriterion
Created []DateCriterion
// MemoryOptimized, when set, requires sys.tables.is_memory_optimized to
// equal it. Only the table listing has such a column; on any other family
// it is ignored rather than failing, since a filter is a description of
// what the caller wants and not every family can express all of it.
MemoryOptimized *bool
}
ObjectFilter narrows a catalog listing. Every criterion narrows it further — they are AND-ed, never OR-ed — and a zero ObjectFilter narrows nothing, so the unfiltered listing is the same call with an empty one.
Matching is case-insensitive regardless of the database's collation (see the note on clause), which is the behaviour a user typing into a filter box expects and the one a case-sensitive database would otherwise break.
func (ObjectFilter) Empty ¶ added in v0.0.10
func (f ObjectFilter) Empty() bool
Empty reports whether f narrows anything at all.
type ObjectPermission ¶
type ObjectPermission string
ObjectPermission represents a single permission on a securable.
const ( PermSelect ObjectPermission = "SELECT" PermInsert ObjectPermission = "INSERT" PermUpdate ObjectPermission = "UPDATE" PermDelete ObjectPermission = "DELETE" PermExecute ObjectPermission = "EXECUTE" PermControl ObjectPermission = "CONTROL" PermView ObjectPermission = "VIEW DEFINITION" PermAlter ObjectPermission = "ALTER" PermReferences ObjectPermission = "REFERENCES" PermTakeOwnership ObjectPermission = "TAKE OWNERSHIP" PermViewChangeTracking ObjectPermission = "VIEW CHANGE TRACKING" )
type Operator ¶ added in v0.0.6
type Operator struct {
ID int
Name string
Enabled bool
EmailAddress string
PagerAddress string
NetSendAddress string
Category string
LastEmailDate time.Time
LastPagerDate time.Time
LastNetSendDate time.Time
// contains filtered or unexported fields
}
Operator represents a SQL Server Agent operator (msdb.dbo.sysoperators) — a notification target for job and alert email.
func (*Operator) DisableContext ¶ added in v0.0.6
DisableContext is the context-aware variant of Disable.
func (*Operator) DropContext ¶ added in v0.0.6
DropContext is the context-aware variant of Drop.
func (*Operator) EnableContext ¶ added in v0.0.6
EnableContext is the context-aware variant of Enable.
func (*Operator) NotifyingAlertSeq ¶ added in v0.0.6
NotifyingAlertSeq returns an iterator over every alert configured to notify this operator.
func (*Operator) NotifyingAlerts ¶ added in v0.0.6
func (o *Operator) NotifyingAlerts() ([]*AlertNotificationRef, error)
NotifyingAlerts returns every alert configured to notify this operator.
func (*Operator) NotifyingAlertsContext ¶ added in v0.0.6
func (o *Operator) NotifyingAlertsContext(ctx context.Context) ([]*AlertNotificationRef, error)
NotifyingAlertsContext is the context-aware variant of NotifyingAlerts.
func (*Operator) NotifyingJobSeq ¶ added in v0.0.6
NotifyingJobSeq returns an iterator over every job configured to e-mail this operator on completion.
func (*Operator) NotifyingJobs ¶ added in v0.0.6
func (o *Operator) NotifyingJobs() ([]*JobNotificationRef, error)
NotifyingJobs returns every job configured to email this operator on completion (sysjobs.notify_email_operator_id) — distinct from NotifyingAlerts, which covers alert-triggered notifications.
func (*Operator) NotifyingJobsContext ¶ added in v0.0.6
func (o *Operator) NotifyingJobsContext(ctx context.Context) ([]*JobNotificationRef, error)
NotifyingJobsContext is the context-aware variant of NotifyingJobs.
func (*Operator) RenameContext ¶ added in v0.0.6
RenameContext is the context-aware variant of Rename.
func (*Operator) SetCategory ¶ added in v0.0.6
SetCategory reassigns the operator's category. category == "" clears it — sent as the real [Uncategorized] category, for the same reason Alert.SetCategory does: sp_update_operator's category check (sp_verify_category, shared with sp_update_alert) rejects an empty name outright.
func (*Operator) SetCategoryContext ¶ added in v0.0.6
SetCategoryContext is the context-aware variant of SetCategory.
func (*Operator) SetEmailAddress ¶ added in v0.0.6
SetEmailAddress changes the operator's email address.
type Parameter ¶ added in v0.0.10
type Parameter struct {
Name string // including the leading @
Ordinal int
DataType DataType
MaxLength int // -1 = MAX
Precision int
Scale int
IsOutput bool
HasDefault bool
}
Parameter mirrors one row of sys.parameters: a parameter of a stored procedure or a function. The return value of a scalar function, which the catalog also stores there as parameter_id 0, is not a parameter and is not returned.
func (*Parameter) TypeString ¶ added in v0.0.10
TypeString returns the T-SQL data-type fragment for the parameter, in the same form ColumnTypeString gives a column.
type PartitionFunction ¶
type PartitionFunction struct {
Name string
FunctionID int
InputType DataType
BoundaryCount int
IsRight bool // RIGHT = boundary is in right partition
Boundaries []string
// contains filtered or unexported fields
}
PartitionFunction mirrors sys.partition_functions.
func (*PartitionFunction) Drop ¶
func (pf *PartitionFunction) Drop() error
Drop drops the partition function.
func (*PartitionFunction) DropContext ¶ added in v0.0.5
func (pf *PartitionFunction) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
func (*PartitionFunction) MergeRange ¶
func (pf *PartitionFunction) MergeRange(value string) error
MergeRange removes a boundary value from the partition function.
func (*PartitionFunction) MergeRangeContext ¶ added in v0.0.5
func (pf *PartitionFunction) MergeRangeContext(ctx context.Context, value string) error
MergeRangeContext is the context-aware variant of MergeRange.
func (*PartitionFunction) SplitRange ¶
func (pf *PartitionFunction) SplitRange(value string) error
SplitRange adds a new boundary value to the partition function.
func (*PartitionFunction) SplitRangeContext ¶ added in v0.0.5
func (pf *PartitionFunction) SplitRangeContext(ctx context.Context, value string) error
SplitRangeContext is the context-aware variant of SplitRange.
type PartitionInfo ¶
PartitionInfo holds per-partition row counts for a table.
type PartitionScheme ¶
type PartitionScheme struct {
Name string
SchemeID int
FunctionName string
FileGroups []string
// contains filtered or unexported fields
}
PartitionScheme mirrors sys.partition_schemes.
func (*PartitionScheme) Drop ¶
func (ps *PartitionScheme) Drop() error
Drop drops the partition scheme.
func (*PartitionScheme) DropContext ¶ added in v0.0.5
func (ps *PartitionScheme) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
type PermissionEntry ¶ added in v0.0.4
type PermissionEntry struct {
Principal string
PrincipalType string // e.g. "DATABASE_ROLE", "SQL_USER"
Grantor string
Permission ObjectPermission
State PermissionState
}
PermissionEntry is one GRANT/DENY entry recorded for a securable, as reported by sys.database_permissions. The permission-name and state enums live in types.go (ObjectPermission, PermissionState).
type PermissionOptions ¶ added in v0.0.8
type PermissionOptions struct {
// WithGrantOption appends WITH GRANT OPTION to a GRANT, letting the
// grantee grant the same permission on to others. GRANT only.
WithGrantOption bool
// Cascade appends CASCADE to a DENY or REVOKE, applying it to every
// principal the grantee passed the permission on to. Required whenever
// the permission being taken away was granted WITH GRANT OPTION.
Cascade bool
// GrantOptionOnly turns a REVOKE into REVOKE GRANT OPTION FOR: the
// grantee keeps the permission but loses the right to grant it onward.
// REVOKE only, and always CASCADE.
GrantOptionOnly bool
}
PermissionOptions carries the GRANT/DENY/REVOKE modifiers the plain Grant/Deny/Revoke trios do not expose. The zero value renders exactly the statement those trios render, at every scope — true by construction since 2026-08-05: each plain method is a one-line delegation to its WithOptions counterpart passing PermissionOptions{}, so there is one renderer (permissionStmt) and one set of error strings rather than two that have to be kept in step.
The three fields are not independent of each other in practice, because SQL Server refuses some sequences outright:
- A permission granted WITH GRANT OPTION cannot be revoked or denied without CASCADE — "the permission was granted WITH GRANT OPTION" is a hard error, not a warning. Anything that takes such a grant away therefore needs Cascade set.
- GrantOptionOnly (REVOKE GRANT OPTION FOR) takes away only the right to re-grant and leaves the underlying GRANT in place. It is the "WITH GRANT OPTION -> plain GRANT" downgrade, and SQL Server requires CASCADE with it as well, so Cascade is implied and need not be set.
CASCADE reaches every principal the grantee granted the permission on to, which is the point of it and also why it is opt-in rather than always sent.
type PermissionState ¶
type PermissionState string
PermissionState represents GRANT / DENY / REVOKE.
const ( PermissionGrant PermissionState = "GRANT" PermissionDeny PermissionState = "DENY" PermissionRevoke PermissionState = "REVOKE" )
type PrincipalSecurable ¶ added in v0.0.5
type PrincipalSecurable struct {
SecurableType string
Schema string
Name string
Permission string
State string
}
PrincipalSecurable is one GRANT/DENY entry for a securable that a principal (typically a database role) has an explicit permission on — the inverse of Permissions, which is "one securable, every principal." This is "one principal, every securable" — SSMS's Database Role Properties > Securables page. SecurableType is "TABLE", "VIEW", "SCHEMA", or "DATABASE"; Schema and Name are empty for "DATABASE".
type ProcParam ¶ added in v0.0.4
type ProcParam struct {
// contains filtered or unexported fields
}
ProcParam is one argument to a stored procedure. Build it with In (input), Out (output), or InOut (both). Output and in/out parameters carry a pointer the returned value is written to, exactly as with database/sql's sql.Out.
type ProcResult ¶ added in v0.0.4
type ProcResult struct {
// ReturnStatus is the procedure's RETURN value (0 unless the procedure
// returns another code). SQL Server uses it by convention to signal
// success (0) or an error (non-zero).
ReturnStatus int32
}
ProcResult is what ExecProc reports beyond the values written to any output parameters' pointers.
type ProcessorInfo ¶ added in v0.0.5
ProcessorInfo holds server-wide CPU/NUMA topology: the header counts on Server Properties > Processors (CPU count, NUMA nodes, hyperthread ratio) and the NUMA column in its per-CPU affinity grid. CPUNUMANode[i] is the NUMA node hosting logical CPU i.
type QueryStoreInfo ¶ added in v0.0.5
type QueryStoreInfo struct {
DesiredState string // "OFF", "READ_ONLY", "READ_WRITE"
ActualState string
ReadOnlyReason int
CurrentStorageMB int64
MaxStorageMB int64
FlushIntervalSec int
IntervalMinutes int
MaxPlansPerQuery int
CaptureMode string // "NONE", "AUTO", "ALL", "CUSTOM"
SizeCleanupMode string // "OFF", "AUTO"
StaleThresholdDays int
WaitStatsCaptureMode string // "OFF", "ON"
CapturePolicyExecCount int
CapturePolicyCompileCPUMs int64
CapturePolicyExecCPUMs int64
CapturePolicyStaleHours int
}
QueryStoreInfo mirrors the single row of sys.database_query_store_options every database has, whether or not Query Store is actually turned on.
type QueryStoreOptions ¶ added in v0.0.5
type QueryStoreOptions struct {
DesiredState string // "OFF", "READ_ONLY", "READ_WRITE"
MaxStorageMB int64
CaptureMode string // "NONE", "AUTO", "ALL", "CUSTOM"
SizeCleanupMode string // "OFF", "AUTO"
StaleThresholdDays int
FlushIntervalSec int
IntervalMinutes int
MaxPlansPerQuery int
WaitStatsCaptureMode string // "OFF", "ON"
// Custom capture policy thresholds, used only when CaptureMode is
// "CUSTOM".
CapturePolicyExecCount int
CapturePolicyCompileCPUMs int64
CapturePolicyExecCPUMs int64
CapturePolicyStaleHours int
}
QueryStoreOptions holds the settings SetQueryStoreOptions writes via ALTER DATABASE ... SET QUERY_STORE = ON (...). DesiredState of "OFF" turns Query Store off and ignores every other field.
type RecoveryModel ¶
type RecoveryModel string
RecoveryModel mirrors SQL Server recovery model options.
const ( RecoveryModelSimple RecoveryModel = "SIMPLE" RecoveryModelFull RecoveryModel = "FULL" RecoveryModelBulkLogged RecoveryModel = "BULK_LOGGED" )
type RelocateFile ¶
RelocateFile maps a logical file name to a new physical path.
type RestoreOptions ¶
type RestoreOptions struct {
// Database is the target database name (required).
Database string
// Action: DATABASE (default), LOG, or FILES.
Action BackupAction
// Files and FileGroups name the logical files / filegroups a
// BackupActionFiles restore covers — see BackupOptions.Files for why
// these are clauses on a RESTORE DATABASE rather than a verb of their own.
Files []string
FileGroups []string
// Devices is one or more backup file paths (required).
Devices []string
// FileNumber selects which backup set on the device to restore (RESTORE's
// WITH FILE = n, 1-based, as reported by BackupHeader.Position). Zero
// leaves the clause off, which SQL Server reads as the first set — so a
// device holding an appended differential or log needs this set
// explicitly, or the full backup at position 1 is restored instead.
FileNumber int
// RelocateFiles maps logical file names to new physical paths.
RelocateFiles []RelocateFile
// NoRecovery keeps the database in RESTORING state (for log shipping / tail-log).
NoRecovery bool
// Recovery transitions the database to ONLINE (default when neither flag is set).
Recovery bool
// StandBy sets standby mode; provide the undo-file path.
StandBy string
// Replace forces restoration over an existing database.
Replace bool
// Checksum verifies backup checksums.
Checksum bool
// Stats controls progress reporting frequency (e.g. 10 = every 10%).
// If Progress is set and Stats is left at 0, it defaults to 10 so
// percent-complete messages actually get emitted.
Stats int
// StopAt performs a point-in-time restore.
StopAt *time.Time
// Progress, if set, is called for every message SQL Server emits while
// the restore runs, including the "N percent processed" notices STATS
// produces — pct is -1 for a message that doesn't carry a percentage.
Progress func(pct int, message string)
}
RestoreOptions configures a RESTORE DATABASE or RESTORE LOG operation.
type RoleMember ¶ added in v0.0.5
type RoleMember struct {
Name string
Type string // e.g. "SQL_USER", "WINDOWS_USER", "DATABASE_ROLE"
}
RoleMember is one direct member of a database role.
type SQLError ¶ added in v0.0.4
type SQLError struct {
// Number is the SQL Server error number (the "Msg" value), e.g. 208
// for "Invalid object name".
Number int32
// State is the error state, disambiguating errors that share a Number.
State uint8
// Class is the severity level (the "Level" value). 0-10 are
// informational; 11-16 are user-correctable; 17+ are software or
// hardware errors.
Class uint8
// Message is the human-readable error text.
Message string
// ServerName is the instance that raised the error.
ServerName string
// ProcName is the stored procedure, function, or trigger that raised
// the error; empty for an ad-hoc batch.
ProcName string
// LineNo is the 1-based line within the batch or procedure.
LineNo int32
// All lists every error the batch produced, first to last. The final
// entry mirrors the fields above. Nil when only a single error is
// reported.
All []SQLError
}
SQLError is a structured SQL Server error — the "Msg 208, Level 16, State 1, Line 4" detail SSMS shows in its Messages pane. It is extracted from the driver's own error type so callers can inspect the error number, severity, and line without importing github.com/microsoft/go-mssqldb directly. Use AsSQLError to obtain one from any error.
func AsSQLError ¶ added in v0.0.4
AsSQLError reports whether err, or any error it wraps, is a SQL Server error and, if so, returns its structured form.
func (*SQLError) Error ¶ added in v0.0.4
Error renders the error in the multi-line form SSMS uses: the Header line followed by the message text.
type Schedule ¶ added in v0.0.6
type Schedule struct {
ID int
Name string
Enabled bool
FreqType ScheduleFreqType
FreqInterval int
FreqSubdayType ScheduleSubdayType
FreqSubdayInterval int
FreqRelativeInterval int
FreqRecurrenceFactor int
ActiveStartDate time.Time
// ActiveEndDate is the zero Time when the schedule has no end date.
ActiveEndDate time.Time
// ActiveStartTime and ActiveEndTime are HHMMSS integers, e.g. 10000 = 01:00:00.
ActiveStartTime int
ActiveEndTime int
OwnerLoginName string
CreateDate time.Time
ModifyDate time.Time
// contains filtered or unexported fields
}
Schedule represents a shared SQL Server Agent schedule (msdb.dbo.sysschedules), which may be attached to more than one job.
func (*Schedule) Description ¶ added in v0.0.6
Description renders the schedule's frequency and active-date range as a human-readable summary, the same shape SSMS shows at the bottom of its own Schedule Properties dialog, e.g. "Occurs every day at 01:00:00. Schedule is active from 2026-01-01."
func (*Schedule) DisableContext ¶ added in v0.0.6
DisableContext is the context-aware variant of Disable.
func (*Schedule) Drop ¶ added in v0.0.6
Drop deletes the schedule via sp_delete_schedule. SQL Server refuses the call (returning a wrapped SQLError) if the schedule is still attached to one or more jobs — detach it first via Job.DetachSchedule.
func (*Schedule) DropContext ¶ added in v0.0.6
DropContext is the context-aware variant of Drop.
func (*Schedule) EnableContext ¶ added in v0.0.6
EnableContext is the context-aware variant of Enable.
func (*Schedule) JobSeq ¶ added in v0.0.6
JobSeq returns an iterator over the jobs this schedule is attached to.
func (*Schedule) Jobs ¶ added in v0.0.6
Jobs returns every job this schedule is attached to — a "referenced by" list. Only JobID/Name/IsEnabled are populated on each returned Job (not its activity/history joins), enough for a reference list without the extra round trips Server.Jobs pays for.
func (*Schedule) JobsContext ¶ added in v0.0.6
JobsContext is the context-aware variant of Jobs.
func (*Schedule) RenameContext ¶ added in v0.0.6
RenameContext is the context-aware variant of Rename.
func (*Schedule) SetActiveRange ¶ added in v0.0.6
SetActiveRange changes the schedule's Duration section: the date range it's active over, plus the daily time-of-day window (HHMMSS) it can fire within. A zero endDate means "no end date".
func (*Schedule) SetActiveRangeContext ¶ added in v0.0.6
func (sch *Schedule) SetActiveRangeContext(ctx context.Context, startDate, endDate time.Time, startTime, endTime int) error
SetActiveRangeContext is the context-aware variant of SetActiveRange.
func (*Schedule) SetFrequency ¶ added in v0.0.6
func (sch *Schedule) SetFrequency(f ScheduleFrequency) error
SetFrequency replaces the schedule's frequency definition.
func (*Schedule) SetFrequencyContext ¶ added in v0.0.6
func (sch *Schedule) SetFrequencyContext(ctx context.Context, f ScheduleFrequency) error
SetFrequencyContext is the context-aware variant of SetFrequency.
type ScheduleFreqType ¶ added in v0.0.6
type ScheduleFreqType int
ScheduleFreqType mirrors sysschedules.freq_type.
const ( FreqOnce ScheduleFreqType = 1 FreqDaily ScheduleFreqType = 4 FreqWeekly ScheduleFreqType = 8 FreqMonthly ScheduleFreqType = 16 FreqMonthlyRelative ScheduleFreqType = 32 FreqAutoStart ScheduleFreqType = 64 FreqOnIdle ScheduleFreqType = 128 )
type ScheduleFrequency ¶ added in v0.0.6
type ScheduleFrequency struct {
FreqType ScheduleFreqType
FreqInterval int
FreqSubdayType ScheduleSubdayType
FreqSubdayInterval int
FreqRelativeInterval int
FreqRecurrenceFactor int
}
ScheduleFrequency bundles the freq_type cluster of sp_update_schedule's parameters — freq_interval's meaning depends on freq_type, so these are only meaningful set together, matching how SSMS's own Schedule Properties dialog submits its whole Frequency section as one unit.
type ScheduleSubdayType ¶ added in v0.0.6
type ScheduleSubdayType int
ScheduleSubdayType mirrors sysschedules.freq_subday_type.
const ( SubdayOnce ScheduleSubdayType = 1 SubdaySeconds ScheduleSubdayType = 2 SubdayMinutes ScheduleSubdayType = 4 SubdayHours ScheduleSubdayType = 8 )
type Schema ¶
Schema mirrors Microsoft.SqlServer.Management.Smo.Schema.
func (*Schema) ChangeOwner ¶
ChangeOwner transfers schema ownership to a new principal.
func (*Schema) ChangeOwnerContext ¶
ChangeOwnerContext is the context-aware variant of ChangeOwner.
func (*Schema) DropContext ¶ added in v0.0.6
DropContext is the context-aware variant of Drop.
func (*Schema) ObjectCount ¶ added in v0.0.5
ObjectCount returns the number of objects (tables, views, procedures, functions, ...) contained in the schema — SSMS's Owned Schemas "Object count" field, fetched lazily only when a schema is selected rather than folded into Schema/SchemasContext (used by every tree-list call).
func (*Schema) ObjectCountContext ¶ added in v0.0.5
ObjectCountContext is the context-aware variant of ObjectCount.
func (*Schema) ObjectCountsByType ¶ added in v0.0.10
func (s *Schema) ObjectCountsByType() (SchemaObjectCounts, error)
ObjectCountsByType returns the schema's contents broken down by category — ObjectCount's total, itemized. It is a separate method rather than a widening of ObjectCount because the two do not agree: ObjectCount is one COUNT over sys.objects, while each count here reproduces the predicate of the listing it stands in for, down to the sys.sql_modules join that keeps a CLR or extended procedure out of the stored-procedure count.
func (*Schema) ObjectCountsByTypeContext ¶ added in v0.0.10
func (s *Schema) ObjectCountsByTypeContext(ctx context.Context) (SchemaObjectCounts, error)
ObjectCountsByTypeContext is the context-aware variant of ObjectCountsByType.
One round trip of six scalar subqueries rather than a single GROUP BY over sys.objects: the counts have to match what ViewsContext, StoredProceduresContext, UserDefinedFunctionsContext, SynonymsContext, SequencesContext and TablesBySchemaContext would each have returned, and those differ in more than the type code — three join sys.sql_modules, two do not filter is_ms_shipped, and synonyms and sequences have catalog views of their own. A schema that does not exist yields zeros, not an error, because SCHEMA_ID returns NULL for it.
type SchemaObjectCounts ¶ added in v0.0.10
type SchemaObjectCounts struct {
Tables int
Views int
StoredProcedures int
Functions int
Synonyms int
Sequences int
}
SchemaObjectCounts is a per-category breakdown of what a schema contains, as Schema Properties' Object summary shows it.
type ScriptCollector ¶ added in v0.0.4
type ScriptCollector struct {
Statements []string
// contains filtered or unexported fields
}
ScriptCollector accumulates the SQL statements a write method would have executed, instead of running them. See WithScript. Statements is guarded by mu since nothing stops a caller from reusing one collector/context across write calls issued from multiple goroutines concurrently.
func WithScript ¶ added in v0.0.4
func WithScript(ctx context.Context) (context.Context, *ScriptCollector)
WithScript returns a derived context carrying a *ScriptCollector. Every gosmo write method invoked with the returned context appends its statement to the collector and returns as if it had succeeded, without touching the server — callers use this to preview or hand off the exact SQL a set of pending edits would run (e.g. an "Script Changes" action that opens the statements in a query editor instead of executing them).
Read methods are unaffected: only the exec chokepoints (Server.execContext, Database.exec) consult the collector.
type ScriptOptions ¶
type ScriptOptions struct {
// Verb selects CREATE (the default), DROP, DROP-and-CREATE, or ALTER.
Verb ScriptVerb
// IncludeHeaders adds an informational header comment. Applies to
// ScriptTable and ScriptDatabase only.
IncludeHeaders bool
// IncludeIfNotExists guards each generated statement with its own
// existence check. Applies to ScriptTable and ScriptDatabase only:
// ScriptView/StoredProcedure/Function return the module's definition
// verbatim from sys.sql_modules and don't synthesize DDL to guard.
//
// The guard is per statement, never a block spanning several. A BEGIN
// block containing GO separators is split across batches — GO is a
// client-side batch break — leaving an unclosed BEGIN in one batch and a
// bare END in another, which is a script that cannot parse.
IncludeIfNotExists bool
// ScriptDrops is the older, narrower spelling of Verb = ScriptDrop, and
// still honoured: it applies only while Verb is left at its zero value.
// New code should set Verb.
ScriptDrops bool
// SchemaQualify prefixes object names with their schema.
SchemaQualify bool
// AnsiPadding emits SET ANSI_PADDING ON before CREATE TABLE.
AnsiPadding bool
}
ScriptOptions controls how objects are scripted.
func DefaultScriptOptions ¶
func DefaultScriptOptions() ScriptOptions
DefaultScriptOptions returns sensible defaults.
type ScriptVerb ¶ added in v0.0.10
type ScriptVerb int
ScriptVerb selects which statement form a Scripter emits.
const ( // ScriptCreate emits the object's CREATE statement (the zero value). ScriptCreate ScriptVerb = iota // ScriptDrop emits its DROP statement. ScriptDrop // ScriptDropAndCreate emits the DROP followed by the CREATE, in that // order and in separate batches — the re-runnable form. ScriptDropAndCreate // ScriptAlter emits ALTER instead of CREATE. Only module objects // (views, stored procedures, functions, triggers) have an ALTER form // that restates the whole object; everything else falls back to CREATE. ScriptAlter )
type Scripter ¶
type Scripter struct {
// contains filtered or unexported fields
}
Scripter generates T-SQL DDL scripts for objects in a database.
func NewScripter ¶
func NewScripter(db *Database, opts ScriptOptions) *Scripter
NewScripter creates a Scripter for the given database.
func (*Scripter) ScriptCheckConstraint ¶ added in v0.0.10
ScriptCheckConstraint generates the script for one CHECK constraint.
func (*Scripter) ScriptCheckConstraintContext ¶ added in v0.0.10
func (sc *Scripter) ScriptCheckConstraintContext(ctx context.Context, schema, table, name string) (string, error)
ScriptCheckConstraintContext is the context-aware variant.
func (*Scripter) ScriptColumnEncryptionKey ¶ added in v0.0.10
ScriptColumnEncryptionKey generates the CREATE (or DROP) script for one Always Encrypted column encryption key.
func (*Scripter) ScriptColumnEncryptionKeyContext ¶ added in v0.0.10
func (sc *Scripter) ScriptColumnEncryptionKeyContext(ctx context.Context, name string) (string, error)
ScriptColumnEncryptionKeyContext is the context-aware variant of ScriptColumnEncryptionKey.
func (*Scripter) ScriptColumnMasterKey ¶ added in v0.0.10
ScriptColumnMasterKey generates the CREATE (or DROP) script for one Always Encrypted column master key.
func (*Scripter) ScriptColumnMasterKeyContext ¶ added in v0.0.10
ScriptColumnMasterKeyContext is the context-aware variant of ScriptColumnMasterKey.
func (*Scripter) ScriptDatabase ¶
ScriptDatabase generates a CREATE DATABASE script for the attached database.
func (*Scripter) ScriptDatabaseContext ¶ added in v0.0.10
ScriptDatabaseContext is the context-aware variant of ScriptDatabase.
The context is not decoration. Alone among the Script* methods this one renders from the Database's own cached metadata rather than querying, and a Database from Server.Database(name) carries none — it is a bare handle by design. Rendering that handle emitted "SET RECOVERY ;" and "COMPATIBILITY_LEVEL = 0", neither of which is valid T-SQL, so a handle with no recovery model is refilled from sys.databases first. Each line is still guarded on its own value: a refresh that cannot run leaves the script short a setting, which is recoverable, rather than syntactically broken, which is not.
func (*Scripter) ScriptDatabaseRole ¶ added in v0.0.10
ScriptDatabaseRole generates the CREATE (or DROP) script for one database role, including the ALTER ROLE statements that restore its membership.
func (*Scripter) ScriptDatabaseRoleContext ¶ added in v0.0.10
ScriptDatabaseRoleContext is the context-aware variant.
func (*Scripter) ScriptDelete ¶ added in v0.0.10
ScriptDelete generates a DELETE template for a table or view.
func (*Scripter) ScriptDeleteContext ¶ added in v0.0.10
ScriptDeleteContext is the context-aware variant of ScriptDelete.
func (*Scripter) ScriptExecute ¶ added in v0.0.10
ScriptExecute generates an EXECUTE template for a stored procedure.
func (*Scripter) ScriptExecuteContext ¶ added in v0.0.10
ScriptExecuteContext is the context-aware variant of ScriptExecute.
func (*Scripter) ScriptForeignKey ¶ added in v0.0.10
ScriptForeignKey generates the script for one foreign key.
func (*Scripter) ScriptForeignKeyContext ¶ added in v0.0.10
func (sc *Scripter) ScriptForeignKeyContext(ctx context.Context, schema, table, name string) (string, error)
ScriptForeignKeyContext is the context-aware variant.
func (*Scripter) ScriptFunction ¶
ScriptFunction returns the CREATE FUNCTION definition.
func (*Scripter) ScriptFunctionCall ¶ added in v0.0.10
ScriptFunctionCall generates a call template for a function: a SELECT of a scalar function's result, or a SELECT from a table-valued one. funcType is the UserDefinedFunction.FuncType — "FN", "IF" or "TF".
func (*Scripter) ScriptFunctionCallContext ¶ added in v0.0.10
func (sc *Scripter) ScriptFunctionCallContext(ctx context.Context, schema, name, funcType string) (string, error)
ScriptFunctionCallContext is the context-aware variant of ScriptFunctionCall.
func (*Scripter) ScriptFunctionContext ¶
ScriptFunctionContext is the context-aware variant.
func (*Scripter) ScriptIndex ¶ added in v0.0.10
ScriptIndex generates the CREATE (or DROP) script for one index on a table. An index backing a primary key or unique constraint is scripted as the ALTER TABLE ... ADD CONSTRAINT it really is — CREATE INDEX cannot recreate it.
func (*Scripter) ScriptIndexContext ¶ added in v0.0.10
func (sc *Scripter) ScriptIndexContext(ctx context.Context, schema, table, name string) (string, error)
ScriptIndexContext is the context-aware variant of ScriptIndex.
func (*Scripter) ScriptInsert ¶ added in v0.0.10
ScriptInsert generates an INSERT template for a table or view.
func (*Scripter) ScriptInsertContext ¶ added in v0.0.10
ScriptInsertContext is the context-aware variant of ScriptInsert.
func (*Scripter) ScriptPartitionFunction ¶ added in v0.0.10
ScriptPartitionFunction generates the CREATE (or DROP) script for one partition function.
func (*Scripter) ScriptPartitionFunctionContext ¶ added in v0.0.10
func (sc *Scripter) ScriptPartitionFunctionContext(ctx context.Context, name string) (string, error)
ScriptPartitionFunctionContext is the context-aware variant of ScriptPartitionFunction.
func (*Scripter) ScriptPartitionScheme ¶ added in v0.0.10
ScriptPartitionScheme generates the CREATE (or DROP) script for one partition scheme.
func (*Scripter) ScriptPartitionSchemeContext ¶ added in v0.0.10
ScriptPartitionSchemeContext is the context-aware variant of ScriptPartitionScheme.
func (*Scripter) ScriptSchema ¶ added in v0.0.10
ScriptSchema generates the CREATE (or DROP) script for one schema.
func (*Scripter) ScriptSchemaContext ¶ added in v0.0.10
ScriptSchemaContext is the context-aware variant of ScriptSchema.
func (*Scripter) ScriptSecurityPolicy ¶ added in v0.0.10
ScriptSecurityPolicy generates the CREATE (or DROP) script for one row-level security policy.
func (*Scripter) ScriptSecurityPolicyContext ¶ added in v0.0.10
func (sc *Scripter) ScriptSecurityPolicyContext(ctx context.Context, schema, name string) (string, error)
ScriptSecurityPolicyContext is the context-aware variant of ScriptSecurityPolicy.
func (*Scripter) ScriptSelect ¶ added in v0.0.10
ScriptSelect generates a SELECT of every column of a table or view.
func (*Scripter) ScriptSelectContext ¶ added in v0.0.10
ScriptSelectContext is the context-aware variant of ScriptSelect.
func (*Scripter) ScriptSequence ¶ added in v0.0.10
ScriptSequence generates the CREATE (or DROP) script for one sequence.
func (*Scripter) ScriptSequenceContext ¶ added in v0.0.10
ScriptSequenceContext is the context-aware variant of ScriptSequence.
func (*Scripter) ScriptStoredProcedure ¶
ScriptStoredProcedure returns the CREATE PROCEDURE definition.
func (*Scripter) ScriptStoredProcedureContext ¶
func (sc *Scripter) ScriptStoredProcedureContext(ctx context.Context, schema, name string) (string, error)
ScriptStoredProcedureContext is the context-aware variant.
func (*Scripter) ScriptSynonym ¶ added in v0.0.10
ScriptSynonym generates the CREATE (or DROP) script for one synonym.
func (*Scripter) ScriptSynonymContext ¶ added in v0.0.10
ScriptSynonymContext is the context-aware variant of ScriptSynonym.
func (*Scripter) ScriptTable ¶
ScriptTable generates a CREATE TABLE (or DROP TABLE) script.
func (*Scripter) ScriptTableContext ¶
ScriptTableContext is the context-aware variant of ScriptTable.
func (*Scripter) ScriptTrigger ¶ added in v0.0.10
ScriptTrigger returns the CREATE TRIGGER definition. schema is the trigger's own schema, i.e. its parent table's.
func (*Scripter) ScriptTriggerContext ¶ added in v0.0.10
ScriptTriggerContext is the context-aware variant of ScriptTrigger.
func (*Scripter) ScriptUpdate ¶ added in v0.0.10
ScriptUpdate generates an UPDATE template for a table or view.
func (*Scripter) ScriptUpdateContext ¶ added in v0.0.10
ScriptUpdateContext is the context-aware variant of ScriptUpdate.
func (*Scripter) ScriptUser ¶ added in v0.0.10
ScriptUser generates the CREATE (or DROP) script for one database user.
func (*Scripter) ScriptUserContext ¶ added in v0.0.10
ScriptUserContext is the context-aware variant of ScriptUser.
func (*Scripter) ScriptView ¶
ScriptView returns the CREATE VIEW definition as stored in sys.sql_modules.
type SearchResult ¶ added in v0.0.4
type SearchResult struct {
Schema string
Name string
TypeDesc string // e.g. "USER_TABLE", "VIEW", "SQL_STORED_PROCEDURE"
}
SearchResult is one object matched by Database.Search.
type SecurableRef ¶ added in v0.0.8
SecurableRef names one schema-scoped object a permission can be granted on. Type is "SCHEMA", "TABLE" or "VIEW", matching the SecurableType strings PrincipalSecurable reports; Schema is empty for a "SCHEMA".
This is deliberately just the identity of the securable, not the object: a permissions UI listing candidates to grant on needs the name and the type and nothing else, and loading Table or View values for thousands of candidates to show a picker is work no caller wants.
type SecurableSearch ¶ added in v0.0.8
SecurableSearch narrows FindSecurables.
Name is matched case-insensitively as a substring of the securable's qualified name — "dbo.Orders" for a table, the bare name for a schema — so both "ord" and "dbo.ord" find dbo.Orders. LIKE wildcards in it are matched literally, not as wildcards. An empty Name matches everything.
Limit caps the rows returned; 0 means no cap. Results are ordered schemas, then tables, then views, each by qualified name, so a capped search returns a stable prefix rather than an arbitrary subset.
type SecurityPolicy ¶
type SecurityPolicy struct {
Name string
Schema string
ObjectID int
IsEnabled bool
IsNotForReplication bool
// IsSchemaBound reports whether the policy binds the schema of the
// tables and predicate functions it names, which blocks any change to
// them while it exists. Part of the CREATE statement, so scripting a
// policy without it produces one that behaves differently.
IsSchemaBound bool
Predicates []*SecurityPredicate
// contains filtered or unexported fields
}
SecurityPolicy mirrors sys.security_policies.
func (*SecurityPolicy) Disable ¶
func (p *SecurityPolicy) Disable() error
Disable disables the security policy.
func (*SecurityPolicy) DisableContext ¶ added in v0.0.5
func (p *SecurityPolicy) DisableContext(ctx context.Context) error
DisableContext is the context-aware variant of Disable.
func (*SecurityPolicy) Drop ¶
func (p *SecurityPolicy) Drop() error
Drop drops the security policy. A policy that isn't there is the server's error, not a silent success — see the note on Database.DropTable.
func (*SecurityPolicy) DropContext ¶ added in v0.0.5
func (p *SecurityPolicy) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
func (*SecurityPolicy) Enable ¶
func (p *SecurityPolicy) Enable() error
Enable enables the security policy.
func (*SecurityPolicy) EnableContext ¶ added in v0.0.5
func (p *SecurityPolicy) EnableContext(ctx context.Context) error
EnableContext is the context-aware variant of Enable.
type SecurityPredicate ¶
type SecurityPredicate struct {
PredicateType string // "FILTER" or "BLOCK"
PredicateDefinition string
TargetSchema string
TargetTable string
Operation string // for BLOCK: AFTER INSERT, AFTER UPDATE, etc.
}
SecurityPredicate represents one predicate in a security policy.
type Sequence ¶
type Sequence struct {
Name string
Schema string
ObjectID int
DataType DataType
StartValue int64
Increment int64
MinValue int64
MaxValue int64
IsCycling bool
IsCached bool
CacheSize int
CurrentValue int64
// contains filtered or unexported fields
}
Sequence mirrors sys.sequences.
func (*Sequence) DropContext ¶ added in v0.0.5
DropContext is the context-aware variant of Drop.
func (*Sequence) NextValueContext ¶ added in v0.0.5
NextValueContext is the context-aware variant of NextValue.
This deliberately uses withConn, not queryRow: "NEXT VALUE FOR" advances the sequence as a side effect of being read, so it isn't safe to retry — unlike every other queryRow caller in this package, re-running it on a fresh connection after a transient failure could silently skip a value. withConn still retries the acquire+USE step (safe, nothing server-side has happened yet), just not the query itself.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server is the top-level object representing a SQL Server instance. Create one with Connect() and use it to enumerate or manage databases, logins, server roles, linked servers, and more.
func Connect ¶
func Connect(opts ConnectionOptions) (*Server, error)
Connect opens a connection to a SQL Server instance and returns a Server. The driver and DSN are chosen automatically based on opts.Auth.
func ConnectContext ¶
func ConnectContext(ctx context.Context, opts ConnectionOptions) (*Server, error)
ConnectContext is the context-aware variant of Connect. The context governs the initial ping and server-info load only; subsequent calls each carry their own context.
func NewServer ¶ added in v0.0.10
NewServer wraps an already-open *sql.DB as a Server, loading the same server metadata ConnectContext loads. Use it when the pool is not gosmo's to open: a connection shared with the rest of an application, a driver wrapped for tracing or retries, or a fake driver in a test.
db must be a SQL Server pool — gosmo builds T-SQL and reads system views, and nothing here checks the dialect. Ownership passes to the returned Server: Close closes db, as it does for a pool Connect opened.
This is the inverse of DB(), and the seam that makes gosmo's read and write paths reachable from a caller's tests. Without it a Server can only come from a real network connection, so any code that takes one — an application's whole database layer — is testable only against a live instance.
func (*Server) ActiveSessionSeq ¶ added in v0.0.6
func (s *Server) ActiveSessionSeq(ctx context.Context, includeSystem bool) iter.Seq2[*ActiveSession, error]
ActiveSessionSeq returns an iterator over every session currently connected to the server, optionally including system sessions.
func (*Server) ActiveSessions ¶
func (s *Server) ActiveSessions(includeSystem bool) ([]*ActiveSession, error)
ActiveSessions returns running sessions. Set includeSystem=true to include SQL Server internal sessions.
func (*Server) ActiveSessionsContext ¶
func (s *Server) ActiveSessionsContext(ctx context.Context, includeSystem bool) ([]*ActiveSession, error)
ActiveSessionsContext is the context-aware variant of ActiveSessions.
func (*Server) AddServerRoleMember ¶ added in v0.0.6
AddServerRoleMember adds member (a login or another server role, by name) to a server role.
func (*Server) AddServerRoleMemberContext ¶ added in v0.0.6
AddServerRoleMemberContext is the context-aware variant of AddServerRoleMember.
func (*Server) AgentInfo ¶ added in v0.0.6
func (s *Server) AgentInfo() (*AgentStatus, error)
AgentInfo reports SQL Server Agent's current run state.
func (*Server) AgentInfoContext ¶ added in v0.0.6
func (s *Server) AgentInfoContext(ctx context.Context) (*AgentStatus, error)
AgentInfoContext is the context-aware variant of AgentInfo.
func (*Server) Alert ¶ added in v0.0.7
Alert returns a lightweight handle for an alert by name, without querying msdb — the alert-side counterpart of Server.Database. ID, Severity, JobName and every other cached field stay at their zero value; AlertByName is what populates them.
Every write method on *Alert addresses the alert by name (Notify, RemoveNotify, Update, ...), so this handle is enough to keep operating on an alert the caller already knows exists — and is the only usable form under a WithScript context, where AlertByNameContext's lookup is a real read and an alert whose sp_add_alert was merely collected is not there to find.
func (*Server) AlertByName ¶ added in v0.0.6
AlertByName returns a single alert by name.
func (*Server) AlertByNameContext ¶ added in v0.0.6
AlertByNameContext is the context-aware variant of AlertByName.
func (*Server) AlertSeq ¶ added in v0.0.6
AlertSeq returns an iterator over all SQL Server Agent alerts.
func (*Server) Alerts ¶ added in v0.0.6
Alerts returns every SQL Server Agent alert defined on the server.
func (*Server) AlertsContext ¶ added in v0.0.6
AlertsContext is the context-aware variant of Alerts.
func (*Server) AvailabilityGroup ¶ added in v0.0.9
func (s *Server) AvailabilityGroup(name string) *AvailabilityGroup
AvailabilityGroup returns a lightweight handle to an availability group by name, with no query and no metadata: every field but Name is zero, so ClusterType, PrimaryReplicaServerName and IsLocalPrimary all read as "unknown" rather than as fact. Use AvailabilityGroupByName to get a group whose fields mean something.
This exists for the one case where the group cannot be read: a secondary of an EXTERNAL- or NONE-cluster group has no row for it until Join succeeds, so the join has to be issued against a handle built from the name alone. It is also what works under a WithScript-derived context, where nothing has been created yet to read back. The same split as Server.Database vs Server.DatabaseByName.
func (*Server) AvailabilityGroupByName ¶ added in v0.0.9
func (s *Server) AvailabilityGroupByName(name string) (*AvailabilityGroup, error)
AvailabilityGroupByName returns one availability group by name, or an error wrapping ErrNotFound if this instance knows no group by that name. That error also satisfies errors.Is(err, sql.ErrNoRows), which this method promised before ErrNotFound existed. Note that neither sentinel was ever returned bare — both have always needed errors.Is rather than ==.
func (*Server) AvailabilityGroupByNameContext ¶ added in v0.0.9
func (s *Server) AvailabilityGroupByNameContext(ctx context.Context, name string) (*AvailabilityGroup, error)
AvailabilityGroupByNameContext is the context-aware variant of AvailabilityGroupByName.
func (*Server) AvailabilityGroupSeq ¶ added in v0.0.9
AvailabilityGroupSeq returns an iterator over every availability group this instance participates in.
func (*Server) AvailabilityGroups ¶ added in v0.0.9
func (s *Server) AvailabilityGroups() ([]*AvailabilityGroup, error)
AvailabilityGroups returns every availability group this instance participates in. Returns an empty slice — not an error — on an instance where Always On is disabled or no group has been created.
func (*Server) AvailabilityGroupsContext ¶ added in v0.0.9
func (s *Server) AvailabilityGroupsContext(ctx context.Context) ([]*AvailabilityGroup, error)
AvailabilityGroupsContext is the context-aware variant of AvailabilityGroups.
func (*Server) Backup ¶
func (s *Server) Backup(opts BackupOptions) error
Backup performs a BACKUP DATABASE (or LOG) operation.
func (*Server) BackupContext ¶
func (s *Server) BackupContext(ctx context.Context, opts BackupOptions) error
BackupContext is the context-aware variant of Backup.
func (*Server) BackupFileList ¶ added in v0.0.5
func (s *Server) BackupFileList(device string) ([]*BackupFile, error)
BackupFileList reads the database files contained in the first backup set on a backup device (RESTORE FILELISTONLY). Use BackupFileListForSet for a device holding more than one set.
func (*Server) BackupFileListContext ¶ added in v0.0.5
BackupFileListContext is the context-aware variant of BackupFileList.
func (*Server) BackupFileListForSet ¶ added in v0.0.8
func (s *Server) BackupFileListForSet(device string, fileNumber int) ([]*BackupFile, error)
BackupFileListForSet reads the database files contained in one particular backup set on a device (RESTORE FILELISTONLY WITH FILE = n).
fileNumber is 1-based, as reported by BackupHeader.Position, and matches RestoreOptions.FileNumber — pass the same value to both or the file list describes a different set from the one being restored. Zero leaves the clause off, which SQL Server reads as the first set.
A device that backups were appended to holds one set per backup, and their file lists differ whenever the sets came from different databases or files were added between them. Building RESTORE's MOVE clauses from the wrong set names logical files the restored set does not contain, which SQL Server rejects outright.
func (*Server) BackupFileListForSetContext ¶ added in v0.0.8
func (s *Server) BackupFileListForSetContext(ctx context.Context, device string, fileNumber int) ([]*BackupFile, error)
BackupFileListForSetContext is the context-aware variant of BackupFileListForSet.
func (*Server) BackupFileSeq ¶ added in v0.0.5
BackupFileSeq returns an iterator over the database files inside the backup set on a backup device.
func (*Server) BackupHeaderSeq ¶ added in v0.0.5
func (s *Server) BackupHeaderSeq(ctx context.Context, device string) iter.Seq2[*BackupHeader, error]
BackupHeaderSeq returns an iterator over the backup sets on a backup device.
func (*Server) BackupHeaders ¶ added in v0.0.5
func (s *Server) BackupHeaders(device string) ([]*BackupHeader, error)
BackupHeaders reads the backup sets on a backup device (RESTORE HEADERONLY) — one BackupHeader per set, in position order.
func (*Server) BackupHeadersContext ¶ added in v0.0.5
BackupHeadersContext is the context-aware variant of BackupHeaders.
func (*Server) BackupHistory ¶
func (s *Server) BackupHistory(databaseName string) ([]*BackupInfo, error)
BackupHistory returns the backup history for a database from msdb.
func (*Server) BackupHistoryContext ¶
func (s *Server) BackupHistoryContext(ctx context.Context, databaseName string) ([]*BackupInfo, error)
BackupHistoryContext is the context-aware variant of BackupHistory.
func (*Server) BackupHistorySeq ¶ added in v0.0.6
func (s *Server) BackupHistorySeq(ctx context.Context, databaseName string) iter.Seq2[*BackupInfo, error]
BackupHistorySeq returns an iterator over databaseName's backup/restore history, as recorded in msdb.
func (*Server) Capabilities ¶ added in v0.0.10
func (s *Server) Capabilities() (*Capabilities, error)
Capabilities reports what the connected login may do at the server scope.
func (*Server) CapabilitiesContext ¶ added in v0.0.10
func (s *Server) CapabilitiesContext(ctx context.Context) (*Capabilities, error)
CapabilitiesContext is the context-aware variant of Capabilities.
One round trip: role membership and permission states come back as one result set of (kind, name, answer) rows, read by name rather than by column position, so adding a name to either list cannot shift the answers after it.
func (*Server) Categories ¶ added in v0.0.6
func (s *Server) Categories(class CategoryClass) ([]*Category, error)
Categories returns every category of the given class.
func (*Server) CategoriesContext ¶ added in v0.0.6
CategoriesContext is the context-aware variant of Categories.
func (*Server) CategorySeq ¶ added in v0.0.6
CategorySeq returns an iterator over every category of the given class (job or alert categories).
func (*Server) ConfigurationByName ¶
func (s *Server) ConfigurationByName(name string) (*ConfigurationOption, error)
ConfigurationByName returns a single option using a direct parameterised query.
func (*Server) ConfigurationByNameContext ¶
func (s *Server) ConfigurationByNameContext(ctx context.Context, name string) (*ConfigurationOption, error)
ConfigurationByNameContext is the context-aware variant.
func (*Server) ConfigurationSeq ¶ added in v0.0.6
ConfigurationSeq returns an iterator over all sp_configure options.
func (*Server) Configurations ¶
func (s *Server) Configurations() ([]*ConfigurationOption, error)
Configurations returns all server configuration options.
func (*Server) ConfigurationsContext ¶
func (s *Server) ConfigurationsContext(ctx context.Context) ([]*ConfigurationOption, error)
ConfigurationsContext is the context-aware variant of Configurations.
func (*Server) CreateAlert ¶ added in v0.0.6
func (s *Server) CreateAlert(req CreateAlertRequest) (*Alert, error)
CreateAlert creates a new SQL Server event alert via sp_add_alert.
func (*Server) CreateAlertContext ¶ added in v0.0.6
CreateAlertContext is the context-aware variant of CreateAlert.
func (*Server) CreateAvailabilityGroup ¶ added in v0.0.9
func (s *Server) CreateAvailabilityGroup(req CreateAvailabilityGroupRequest) (*AvailabilityGroup, error)
CreateAvailabilityGroup creates an availability group with this instance as its primary.
This is step 2 of four; see this section's doc comment for the rest. On its own it leaves a group whose secondaries are all disconnected, because none of them has joined yet.
func (*Server) CreateAvailabilityGroupContext ¶ added in v0.0.9
func (s *Server) CreateAvailabilityGroupContext(ctx context.Context, req CreateAvailabilityGroupRequest) (*AvailabilityGroup, error)
CreateAvailabilityGroupContext is the context-aware variant of CreateAvailabilityGroup.
func (*Server) CreateCategory ¶ added in v0.0.6
func (s *Server) CreateCategory(class CategoryClass, name string) error
CreateCategory creates a new category via sp_add_category.
func (*Server) CreateCategoryContext ¶ added in v0.0.6
CreateCategoryContext is the context-aware variant of CreateCategory.
func (*Server) CreateDatabase ¶
func (s *Server) CreateDatabase(name string, opts *CreateDatabaseOptions) error
CreateDatabase creates a new database with the given name and optional options.
func (*Server) CreateDatabaseContext ¶
func (s *Server) CreateDatabaseContext(ctx context.Context, name string, opts *CreateDatabaseOptions) error
CreateDatabaseContext is the context-aware variant of CreateDatabase.
func (*Server) CreateDatabaseMirroringEndpoint ¶ added in v0.0.9
func (s *Server) CreateDatabaseMirroringEndpoint(spec EndpointSpec) (*DatabaseMirroringEndpoint, error)
CreateDatabaseMirroringEndpoint creates the instance's database mirroring endpoint, started.
Fails if the instance already has one, whatever it is named — see this file's doc comment. Read DatabaseMirroringEndpoint first and reuse what is there rather than treating "no endpoint of my name" as "no endpoint".
func (*Server) CreateDatabaseMirroringEndpointContext ¶ added in v0.0.9
func (s *Server) CreateDatabaseMirroringEndpointContext(ctx context.Context, spec EndpointSpec) (*DatabaseMirroringEndpoint, error)
CreateDatabaseMirroringEndpointContext is the context-aware variant of CreateDatabaseMirroringEndpoint.
func (*Server) CreateJob ¶
func (s *Server) CreateJob(req CreateJobRequest) (*Job, error)
CreateJob creates a new SQL Server Agent job.
func (*Server) CreateJobContext ¶
CreateJobContext is the context-aware variant of CreateJob. It also enlists the job to run on the local server via sp_add_jobserver — without that, SQL Server Agent refuses to start the job (sp_start_job: "does not have any job server or servers defined") or let an alert target it (sp_update_alert/sp_add_alert: "cannot be used by an alert"). Multi-server (MSX/TSX) target-server selection is out of scope here, so "(local)" is the only target.
func (*Server) CreateLogin ¶
func (s *Server) CreateLogin(name, password string, opts *CreateLoginOptions) error
CreateLogin creates a login. With no CreateLoginOptions.Source, an empty password means a Windows login (FROM WINDOWS) and a non-empty one a SQL login; set Source to create any of the other kinds.
func (*Server) CreateLoginContext ¶
func (s *Server) CreateLoginContext(ctx context.Context, name, password string, opts *CreateLoginOptions) error
CreateLoginContext is the context-aware variant of CreateLogin.
Security: the password is never string-concatenated raw into the SQL text — it's quoted via nStringLiteral (N'...', doubling any embedded quote), the same escaping every other literal in this package uses. HASHED is deliberately not used here: it tells SQL Server the value is already one of its own password-hash formats, not a cleartext password, so passing an arbitrary hex encoding of the cleartext under HASHED either fails outright or creates a login nothing can ever authenticate as.
DefaultDatabase reaches an external-provider login through a following ALTER LOGIN, since FROM EXTERNAL PROVIDER takes no WITH option list. A certificate- or asymmetric-key-mapped login cannot have one at all — SQL Server rejects DEFAULT_DATABASE for those in both CREATE and ALTER ("Cannot use the parameter DEFAULT_DATABASE for a certificate or asymmetric key login", verified live) — so asking for one is an error rather than a statement the server will refuse.
func (*Server) CreateOperator ¶ added in v0.0.6
func (s *Server) CreateOperator(req CreateOperatorRequest) (*Operator, error)
CreateOperator creates a new operator via sp_add_operator.
func (*Server) CreateOperatorContext ¶ added in v0.0.6
func (s *Server) CreateOperatorContext(ctx context.Context, req CreateOperatorRequest) (*Operator, error)
CreateOperatorContext is the context-aware variant of CreateOperator.
func (*Server) CreateSchedule ¶ added in v0.0.6
func (s *Server) CreateSchedule(req CreateScheduleRequest) (*Schedule, error)
CreateSchedule creates a new shared schedule via sp_add_schedule. The returned Schedule is not yet attached to any job — see Job.AttachSchedule.
func (*Server) CreateScheduleContext ¶ added in v0.0.6
func (s *Server) CreateScheduleContext(ctx context.Context, req CreateScheduleRequest) (*Schedule, error)
CreateScheduleContext is the context-aware variant of CreateSchedule.
func (*Server) CredentialSeq ¶ added in v0.0.4
CredentialSeq returns an iterator over all server-level credentials.
func (*Server) Credentials ¶ added in v0.0.4
func (s *Server) Credentials() ([]*Credential, error)
Credentials returns every server-level credential.
func (*Server) CredentialsContext ¶ added in v0.0.4
func (s *Server) CredentialsContext(ctx context.Context) ([]*Credential, error)
CredentialsContext is the context-aware variant of Credentials.
func (*Server) CurrentDatabase ¶ added in v0.0.4
CurrentDatabase returns the name of the database the connection is currently in — the login's default database when ConnectionOptions.Database was left empty at connect time, or whatever a session-level USE has since switched to.
func (*Server) CurrentDatabaseContext ¶ added in v0.0.4
CurrentDatabaseContext is the context-aware variant of CurrentDatabase.
func (*Server) CurrentLogin ¶ added in v0.0.6
CurrentLogin returns the server login name the connection is authenticated as (SUSER_NAME()) — the real login behind the connection, which for Windows/Entra auth differs from whatever was passed as ConnectionOptions.User (often empty for those methods).
func (*Server) CurrentLoginContext ¶ added in v0.0.6
CurrentLoginContext is the context-aware variant of CurrentLogin.
func (*Server) CycleErrorLog ¶
CycleErrorLog closes the current error log and opens a new one. Equivalent to sp_cycle_errorlog. It is CycleLog fixed to the SQL Server log family.
func (*Server) CycleErrorLogContext ¶
CycleErrorLogContext is the context-aware variant of CycleErrorLog.
func (*Server) CycleLog ¶ added in v0.0.10
func (s *Server) CycleLog(logType ErrorLogType) error
CycleLog closes the current log of the given family and opens a new one, renumbering the archives and deleting the oldest if the instance is already holding as many as it is configured to keep.
func (*Server) CycleLogContext ¶ added in v0.0.10
func (s *Server) CycleLogContext(ctx context.Context, logType ErrorLogType) error
CycleLogContext is the context-aware variant of CycleLog. Cycling the Agent log requires SQL Server Agent to be running.
func (*Server) Database ¶ added in v0.0.5
Database returns a lightweight handle for name without querying the server at all — unlike DatabaseByName/DatabaseByNameContext, it doesn't verify the database exists or populate State/RecoveryModel/Collation/ CompatibilityLevel/etc. (they stay at their zero value). Every write method on *Database (AddFileGroupContext, SetDatabaseOptionContext, SetOwnerContext, ...) only ever needs the database's name, never those cached fields, so this is sufficient for issuing further ALTER-style calls against a database the caller already knows exists — most commonly one it just created in the same operation. It's also the only way to do that under a WithScript-derived context: DatabaseByNameContext's own lookup query is a real read, not a write, so it isn't captured by ScriptCollector and would fail outright (or return stale data) for a database whose CREATE DATABASE was itself only scripted, not actually run.
func (*Server) DatabaseByName ¶
DatabaseByName returns a single database by name, querying sys.databases so the returned handle is verified to exist and has State/RecoveryModel/ Collation/CompatibilityLevel/etc. populated. Use it when you need to read those or to confirm the database is there; use Database when you only need a handle to issue further ALTER-style calls against a database you already know exists. The two are not interchangeable — see Database.
func (*Server) DatabaseByNameContext ¶
DatabaseByNameContext is the context-aware variant of DatabaseByName.
func (*Server) DatabaseMirroringEndpoint ¶ added in v0.0.9
func (s *Server) DatabaseMirroringEndpoint() (*DatabaseMirroringEndpoint, error)
DatabaseMirroringEndpoint returns the instance's database mirroring endpoint, or nil when it has none.
func (*Server) DatabaseMirroringEndpointContext ¶ added in v0.0.9
func (s *Server) DatabaseMirroringEndpointContext(ctx context.Context) (*DatabaseMirroringEndpoint, error)
DatabaseMirroringEndpointContext is the context-aware variant of DatabaseMirroringEndpoint.
Returns (nil, nil) when the instance has no such endpoint — a normal state on an instance that has never been put in an availability group, and not an error.
func (*Server) DatabaseRecoveryStatuses ¶ added in v0.0.10
func (s *Server) DatabaseRecoveryStatuses() ([]*DatabaseRecoveryStatus, error)
DatabaseRecoveryStatuses returns the log backup chain state of every database on the server.
func (*Server) DatabaseRecoveryStatusesContext ¶ added in v0.0.10
func (s *Server) DatabaseRecoveryStatusesContext(ctx context.Context) ([]*DatabaseRecoveryStatus, error)
DatabaseRecoveryStatusesContext is the context-aware variant of DatabaseRecoveryStatuses.
One read for the whole server: the state is wanted per database, but a caller deciding which databases qualify for something needs them all, and sys.database_recovery_status is a server-scoped view.
func (*Server) DatabaseSeq ¶
DatabaseSeq returns an iterator over all databases on the server. The second yield value carries any error that stopped the iteration.
func (*Server) DatabasesContext ¶
DatabasesContext returns all databases, honouring the provided context.
func (*Server) DeleteCategory ¶ added in v0.0.6
func (s *Server) DeleteCategory(class CategoryClass, name string) error
DeleteCategory deletes a category via sp_delete_category.
func (*Server) DeleteCategoryContext ¶ added in v0.0.6
DeleteCategoryContext is the context-aware variant of DeleteCategory.
func (*Server) DenyServerPermission ¶ added in v0.0.4
DenyServerPermission denies a server-level permission to principal.
func (*Server) DenyServerPermissionContext ¶ added in v0.0.4
func (s *Server) DenyServerPermissionContext(ctx context.Context, permission, principal string) error
DenyServerPermissionContext is the context-aware variant of DenyServerPermission. See GrantServerPermissionContext's doc comment for the USE master prefix.
func (*Server) DenyServerPermissionWithOptions ¶ added in v0.0.8
func (s *Server) DenyServerPermissionWithOptions(permission, principal string, opts PermissionOptions) error
DenyServerPermissionWithOptions denies a server-level permission to principal, honouring opts.
func (*Server) DenyServerPermissionWithOptionsContext ¶ added in v0.0.8
func (s *Server) DenyServerPermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
DenyServerPermissionWithOptionsContext is the context-aware variant of DenyServerPermissionWithOptions. See GrantServerPermissionContext for the USE master prefix.
func (*Server) DiskVolumeSeq ¶ added in v0.0.5
DiskVolumeSeq returns an iterator over the server's storage volumes.
func (*Server) DiskVolumes ¶ added in v0.0.5
func (s *Server) DiskVolumes() ([]DiskVolumeInfo, error)
DiskVolumes returns free/total space for every storage volume backing a database file on the server.
func (*Server) DiskVolumesContext ¶ added in v0.0.5
func (s *Server) DiskVolumesContext(ctx context.Context) ([]DiskVolumeInfo, error)
DiskVolumesContext is the context-aware variant of DiskVolumes.
func (*Server) DropDatabase ¶
DropDatabase drops the named database. When force is true, active connections are terminated first.
func (*Server) DropDatabaseContext ¶
DropDatabaseContext is the context-aware variant of DropDatabase.
func (*Server) DropLoginContext ¶
DropLoginContext is the context-aware variant of DropLogin.
func (*Server) DropServerRole ¶ added in v0.0.9
DropServerRole drops a user-defined server role. A fixed role, or one that still owns another role, is refused by the server, not here.
func (*Server) DropServerRoleContext ¶ added in v0.0.9
DropServerRoleContext is the context-aware variant of DropServerRole.
func (*Server) EffectiveServerPermissionSeq ¶ added in v0.0.8
func (s *Server) EffectiveServerPermissionSeq(ctx context.Context, login string) iter.Seq2[*EffectivePermission, error]
EffectiveServerPermissionSeq returns an iterator over every server-level permission login effectively holds.
func (*Server) EffectiveServerPermissions ¶ added in v0.0.8
func (s *Server) EffectiveServerPermissions(login string) ([]*EffectivePermission, error)
EffectiveServerPermissions returns every server-level permission login effectively holds — SSMS's Effective tab on a Login Properties > Securables page, with the server row selected.
login must be a *login*. A server role is not accepted, for the same reason a database role isn't (see EffectivePermissions): SQL Server refuses to impersonate one, with Msg 15406, the server-principal wording of the same error. The impersonation is EXECUTE AS LOGIN rather than EXECUTE AS USER, and it needs IMPERSONATE on that login (CONTROL SERVER covers it).
func (*Server) EffectiveServerPermissionsContext ¶ added in v0.0.8
func (s *Server) EffectiveServerPermissionsContext(ctx context.Context, login string) ([]*EffectivePermission, error)
EffectiveServerPermissionsContext is the context-aware variant of EffectiveServerPermissions.
func (*Server) EnumErrorLogSeq ¶ added in v0.0.9
func (s *Server) EnumErrorLogSeq(ctx context.Context, logType ErrorLogType) iter.Seq2[*ErrorLogFile, error]
EnumErrorLogSeq returns an iterator over the available log files of the given family.
func (*Server) EnumErrorLogs ¶ added in v0.0.9
func (s *Server) EnumErrorLogs(logType ErrorLogType) ([]*ErrorLogFile, error)
EnumErrorLogs lists the available log files of the given family.
func (*Server) EnumErrorLogsContext ¶ added in v0.0.9
func (s *Server) EnumErrorLogsContext(ctx context.Context, logType ErrorLogType) ([]*ErrorLogFile, error)
EnumErrorLogsContext is the context-aware variant of EnumErrorLogs. Results are ordered by Number, current log first — sp_enumerrorlogs returns the Agent family's current log last, not first.
func (*Server) EnumFileSystem ¶ added in v0.0.9
func (s *Server) EnumFileSystem(path string) ([]*FileSystemEntry, error)
EnumFileSystem lists the files and directories directly inside path on the server host.
func (*Server) EnumFileSystemContext ¶ added in v0.0.9
func (s *Server) EnumFileSystemContext(ctx context.Context, path string) ([]*FileSystemEntry, error)
EnumFileSystemContext is the context-aware variant of EnumFileSystem.
On SQL Server 2017 and later this reads sys.dm_os_enumerate_filesystem, which reports sizes and timestamps; anything else uses xp_dirtree, which reports names and the file/directory flag only.
The version gate is deliberately positive — the DMV is used only when the instance is *known* to be 2017 or later, and an unknown version (no ServerInfo loaded, or a major of 0) takes xp_dirtree. xp_dirtree exists on every version this library talks to and the DMV does not, so guessing toward the DMV turns an unknown pre-2017 instance into a hard failure, while guessing toward xp_dirtree costs a known-modern one only its Size and LastModified fields. A caller browsing for a path needs the names and the directory flag; it can live without the other two. Degrade, don't fail.
func (*Server) EnumFileSystemIsLegacy ¶ added in v0.0.10
EnumFileSystemIsLegacy reports whether EnumFileSystem will take the xp_dirtree path rather than sys.dm_os_enumerate_filesystem — the same positive version gate EnumFileSystemContext applies, exposed so a caller can reason about what it is about to get.
Two things differ on that path and a caller may need to say so: entries carry no Size or LastModified, and xp_dirtree returns *no rows and no error* to a login that is not sysadmin, which is indistinguishable from an empty directory unless the caller knows which path ran.
func (*Server) EventAlertSeq ¶ added in v0.0.6
EventAlertSeq returns an iterator over the SQL-only-implementable subset of alerts (see Server.EventAlerts).
func (*Server) EventAlerts ¶ added in v0.0.6
EventAlerts returns only plain SQL Server event alerts — the SQL-only implementable subset (see Alert.IsEventAlert). WMI alerts and performance-condition alerts are excluded, since they depend on non-SQL subsystems.
func (*Server) EventAlertsContext ¶ added in v0.0.6
EventAlertsContext is the context-aware variant of EventAlerts.
func (*Server) FileSystemExists ¶ added in v0.0.9
FileSystemExists reports whether path exists on the server host and whether it is a directory. A path that doesn't exist is not an error: exists is false and err is nil.
func (*Server) FileSystemExistsContext ¶ added in v0.0.9
func (s *Server) FileSystemExistsContext(ctx context.Context, path string) (exists, isDirectory bool, err error)
FileSystemExistsContext is the context-aware variant of FileSystemExists.
func (*Server) FixedDrives ¶ added in v0.0.9
func (s *Server) FixedDrives() ([]*FixedDrive, error)
FixedDrives returns the fixed drives visible to the SQL Server host.
func (*Server) FixedDrivesContext ¶ added in v0.0.9
func (s *Server) FixedDrivesContext(ctx context.Context) ([]*FixedDrive, error)
FixedDrivesContext is the context-aware variant of FixedDrives. It reads sys.dm_os_enumerate_fixed_drives on SQL Server 2019 and later, and falls back to xp_fixeddrives — which reports the drive letter and free megabytes only — on older instances.
The fallback is Windows-only: xp_fixeddrives does not exist on SQL Server on Linux, so a pre-2019 Linux instance returns an error here rather than the single root filesystem FixedDrive documents. That is deliberate rather than unnoticed — a Linux host has no drive list to browse, and goSSMS's file dialog only asks for one when a path walks above a root, which "/"-separated paths never do (PosixPathRules.Parent("/") == "/"). Do not "fix" it by synthesizing a "/" entry; there is no caller that would see it.
func (*Server) GrantServerPermission ¶ added in v0.0.4
GrantServerPermission grants a server-level permission to principal.
func (*Server) GrantServerPermissionContext ¶ added in v0.0.4
func (s *Server) GrantServerPermissionContext(ctx context.Context, permission, principal string) error
GrantServerPermissionContext is the context-aware variant of GrantServerPermission.
SQL Server rejects GRANT/DENY/REVOKE at server scope outright unless the session's current database is master ("Permissions at the server scope can only be granted when the current database is master") — its own restriction, not one gosmo imposes — so every statement here is prefixed with USE master in the same batch.
That USE does not leak into whatever borrows the connection next, and the reason is the driver, not this package: USE is session state and would otherwise survive the connection's return to the pool. database/sql calls driver.SessionResetter.ResetSession before handing a pooled connection to its next user, and go-mssqldb implements it by flagging the next TDS batch as a connection reset (Conn.ResetSession -> sendSqlBatch72's resetSession), which restores the session's database to the connection string's.
Verified live 2026-08-01, A/B against a connection opened with Database set: eight pooled connections all still reported that database after a GRANT. Recorded because the shape of this code invites the opposite conclusion — a review that session proposed replacing it with a pinned connection that reads DB_NAME(), switches, and switches back, which is three extra round trips per grant to re-solve what the driver already handles.
func (*Server) GrantServerPermissionWithOptions ¶ added in v0.0.8
func (s *Server) GrantServerPermissionWithOptions(permission, principal string, opts PermissionOptions) error
GrantServerPermissionWithOptions grants a server-level permission to principal, honouring opts.
func (*Server) GrantServerPermissionWithOptionsContext ¶ added in v0.0.8
func (s *Server) GrantServerPermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
GrantServerPermissionWithOptionsContext is the context-aware variant of GrantServerPermissionWithOptions. See GrantServerPermissionContext for the USE master prefix every server-scoped statement carries.
func (*Server) Info ¶
func (s *Server) Info() *ServerInfo
Info returns cached server metadata (version, edition, paths ...).
func (*Server) Job ¶ added in v0.0.7
Job returns a lightweight handle for a job by name, without querying msdb — the job-side counterpart of Server.Database. JobID, Category, LastRunOutcome and every other cached field stay at their zero value; JobByName is what populates them.
Every write method on *Job builds its statement from Name alone (AddStep, AttachSchedule, Start, Rename, ...), so this handle is enough to keep operating on a job the caller already knows exists — and is the only usable form under a WithScript context, where JobByNameContext's lookup is a real read and a job whose sp_add_job was merely collected is not there to find.
func (*Server) JobByName ¶
JobByName returns a single job by name using a direct parameterised query.
func (*Server) JobByNameContext ¶
JobByNameContext is the context-aware variant of JobByName.
func (*Server) JobHistory ¶ added in v0.0.6
func (s *Server) JobHistory(limit int) ([]*JobHistoryEntry, error)
JobHistory returns the most recent job-level history entries (step_id = 0, i.e. the overall outcome of each run rather than a single step's) across every job, most recent first. Pass limit=0 for the default of 100 rows.
func (*Server) JobHistoryContext ¶ added in v0.0.6
JobHistoryContext is the context-aware variant of JobHistory.
func (*Server) JobHistorySeq ¶ added in v0.0.6
JobHistorySeq returns an iterator over the most recent job history entries across every SQL Server Agent job, up to limit.
func (*Server) JobsContext ¶
JobsContext is the context-aware variant of Jobs.
func (*Server) KillSession ¶
KillSession terminates a session by session ID.
func (*Server) KillSessionContext ¶
KillSessionContext is the context-aware variant of KillSession.
func (*Server) LanguageSeq ¶ added in v0.0.4
LanguageSeq returns an iterator over all languages installed on the server.
func (*Server) Languages ¶ added in v0.0.4
Languages returns every language installed on the server.
func (*Server) LanguagesContext ¶ added in v0.0.4
LanguagesContext is the context-aware variant of Languages.
func (*Server) LinkedServerSeq ¶ added in v0.0.6
LinkedServerSeq returns an iterator over all linked servers.
func (*Server) LinkedServers ¶
func (s *Server) LinkedServers() ([]*LinkedServer, error)
LinkedServers returns all linked servers defined on this instance.
func (*Server) LinkedServersContext ¶
func (s *Server) LinkedServersContext(ctx context.Context) ([]*LinkedServer, error)
LinkedServersContext is the context-aware variant of LinkedServers.
func (*Server) Login ¶ added in v0.0.5
Login returns a lightweight handle for name without querying the server at all — unlike LoginByName/LoginByNameContext, it doesn't verify the login exists or populate SID/LoginType/IsDisabled/etc. (they stay at their zero value). Every write method on *Login (AddServerRoleMemberContext, DisableContext, ChangePasswordContext, ...) only ever needs the login's name, never those cached fields, so this is sufficient for issuing further ALTER-style calls against a login the caller already knows exists — most commonly one it just created in the same operation. See Server.Database's doc comment for why this also matters under a WithScript-derived context.
func (*Server) LoginByName ¶ added in v0.0.4
LoginByName returns a single server-level login by name.
func (*Server) LoginByNameContext ¶ added in v0.0.4
LoginByNameContext is the context-aware variant of LoginByName.
func (*Server) LoginsContext ¶
LoginsContext is the context-aware variant of Logins.
Every server-level login is listed, not just the SQL/Windows ones: the type filter also admits Entra ('E','X') and the certificate- and asymmetric-key-mapped logins ('C','K') that hold permissions for signed code, which is what SSMS's Logins folder shows.
func (*Server) MailProfileSeq ¶ added in v0.0.6
MailProfileSeq returns an iterator over all Database Mail profiles.
func (*Server) MailProfiles ¶
func (s *Server) MailProfiles() ([]*MailProfile, error)
MailProfiles returns all Database Mail profiles from msdb.
func (*Server) MailProfilesContext ¶
func (s *Server) MailProfilesContext(ctx context.Context) ([]*MailProfile, error)
MailProfilesContext is the context-aware variant of MailProfiles.
func (*Server) MemoryStats ¶ added in v0.0.4
func (s *Server) MemoryStats() (*ServerMemoryStats, error)
MemoryStats returns live server memory figures.
func (*Server) MemoryStatsContext ¶ added in v0.0.4
func (s *Server) MemoryStatsContext(ctx context.Context) (*ServerMemoryStats, error)
MemoryStatsContext is the context-aware variant of MemoryStats.
func (*Server) Operator ¶ added in v0.0.7
Operator returns a lightweight handle for an operator by name, without querying msdb — the operator-side counterpart of Server.Database. ID, EmailAddress, Category and every other cached field stay at their zero value; OperatorByName is what populates them.
Every write method on *Operator addresses the operator by name, so this handle is enough to keep operating on an operator the caller already knows exists — and is the only usable form under a WithScript context, where OperatorByNameContext's lookup is a real read and an operator whose sp_add_operator was merely collected is not there to find.
func (*Server) OperatorByName ¶ added in v0.0.6
OperatorByName returns a single operator by name.
func (*Server) OperatorByNameContext ¶ added in v0.0.6
OperatorByNameContext is the context-aware variant of OperatorByName.
func (*Server) OperatorSeq ¶ added in v0.0.6
OperatorSeq returns an iterator over all SQL Server Agent operators.
func (*Server) Operators ¶ added in v0.0.6
Operators returns every SQL Server Agent operator defined on the server.
func (*Server) OperatorsContext ¶ added in v0.0.6
OperatorsContext is the context-aware variant of Operators.
func (*Server) ProcessorInfo ¶ added in v0.0.5
func (s *Server) ProcessorInfo() (*ProcessorInfo, error)
ProcessorInfo returns server-wide CPU/NUMA topology.
func (*Server) ProcessorInfoContext ¶ added in v0.0.5
func (s *Server) ProcessorInfoContext(ctx context.Context) (*ProcessorInfo, error)
ProcessorInfoContext is the context-aware variant of ProcessorInfo.
func (*Server) ReadErrorLog ¶
func (s *Server) ReadErrorLog(logNumber int) ([]*ErrorLogEntry, error)
ReadErrorLog reads a SQL Server error log file. Pass logNumber=0 for the current log, 1 for the first archived log, etc.
func (*Server) ReadErrorLogContext ¶
ReadErrorLogContext is the context-aware variant of ReadErrorLog. It is ReadLogContext fixed to the SQL Server log family.
func (*Server) ReadErrorLogSeq ¶ added in v0.0.6
func (s *Server) ReadErrorLogSeq(ctx context.Context, logNumber int) iter.Seq2[*ErrorLogEntry, error]
ReadErrorLogSeq returns an iterator over the lines of the given SQL Server error log (0 = current, 1 = Errorlog.1, …).
func (*Server) ReadLog ¶ added in v0.0.9
func (s *Server) ReadLog(logType ErrorLogType, logNumber int) ([]*ErrorLogEntry, error)
ReadLog reads one log file of the given family. Pass logNumber=0 for the current log, 1 for the first archived log, etc.
func (*Server) ReadLogContext ¶ added in v0.0.9
func (s *Server) ReadLogContext(ctx context.Context, logType ErrorLogType, logNumber int) ([]*ErrorLogEntry, error)
ReadLogContext is the context-aware variant of ReadLog. Which of an entry's Process and ErrorLevel is populated follows logType — see ErrorLogEntry.
func (*Server) ReadLogFiltered ¶ added in v0.0.10
func (s *Server) ReadLogFiltered(logType ErrorLogType, logNumber int, search LogSearch) ([]*ErrorLogEntry, error)
ReadLogFiltered reads one log file of the given family, keeping only the entries the search matches.
func (*Server) ReadLogFilteredContext ¶ added in v0.0.10
func (s *Server) ReadLogFilteredContext(ctx context.Context, logType ErrorLogType, logNumber int, search LogSearch) ([]*ErrorLogEntry, error)
ReadLogFilteredContext is the context-aware variant of ReadLogFiltered, and carries the read every other method here delegates to.
func (*Server) ReadLogSeq ¶ added in v0.0.9
func (s *Server) ReadLogSeq(ctx context.Context, logType ErrorLogType, logNumber int) iter.Seq2[*ErrorLogEntry, error]
ReadLogSeq returns an iterator over the lines of the given log file of the given family (0 = current, 1 = the first archive, …).
func (*Server) Reconfigure ¶
Reconfigure applies pending sp_configure changes. Pass override=true to use RECONFIGURE WITH OVERRIDE (bypasses range checks).
func (*Server) ReconfigureContext ¶
ReconfigureContext is the context-aware variant of Reconfigure.
func (*Server) RemoveServerRoleMember ¶ added in v0.0.6
RemoveServerRoleMember removes member from a server role.
func (*Server) RemoveServerRoleMemberContext ¶ added in v0.0.6
func (s *Server) RemoveServerRoleMemberContext(ctx context.Context, roleName, memberName string) error
RemoveServerRoleMemberContext is the context-aware variant of RemoveServerRoleMember.
func (*Server) RenameDatabase ¶ added in v0.0.9
RenameDatabase renames a database (ALTER DATABASE ... MODIFY NAME). The server needs exclusive access to it, so any other connection to the database fails the statement outright rather than waiting.
When force is true the database is put into SINGLE_USER WITH ROLLBACK IMMEDIATE first — terminating those connections and rolling back their transactions — and back to MULTI_USER afterwards, including when the rename itself fails, so a refused rename never leaves the database single-user.
func (*Server) RenameDatabaseContext ¶ added in v0.0.9
func (s *Server) RenameDatabaseContext(ctx context.Context, oldName, newName string, force bool) error
RenameDatabaseContext is the context-aware variant of RenameDatabase.
func (*Server) Restore ¶
func (s *Server) Restore(opts RestoreOptions) error
Restore performs a RESTORE DATABASE (or LOG) operation.
func (*Server) RestoreContext ¶
func (s *Server) RestoreContext(ctx context.Context, opts RestoreOptions) error
RestoreContext is the context-aware variant of Restore.
func (*Server) RevokeServerPermission ¶ added in v0.0.4
RevokeServerPermission revokes a server-level permission from principal.
func (*Server) RevokeServerPermissionContext ¶ added in v0.0.4
func (s *Server) RevokeServerPermissionContext(ctx context.Context, permission, principal string) error
RevokeServerPermissionContext is the context-aware variant of RevokeServerPermission. See GrantServerPermissionContext's doc comment for the USE master prefix.
func (*Server) RevokeServerPermissionWithOptions ¶ added in v0.0.8
func (s *Server) RevokeServerPermissionWithOptions(permission, principal string, opts PermissionOptions) error
RevokeServerPermissionWithOptions revokes a server-level permission from principal, honouring opts.
func (*Server) RevokeServerPermissionWithOptionsContext ¶ added in v0.0.8
func (s *Server) RevokeServerPermissionWithOptionsContext(ctx context.Context, permission, principal string, opts PermissionOptions) error
RevokeServerPermissionWithOptionsContext is the context-aware variant of RevokeServerPermissionWithOptions. See GrantServerPermissionContext for the USE master prefix.
func (*Server) Schedule ¶ added in v0.0.7
Schedule returns a lightweight handle for a shared schedule by name, without querying msdb — the schedule-side counterpart of Server.Database. ID, FreqType, ActiveStartDate and every other cached field stay at their zero value; ScheduleByName is what populates them.
Every write method on *Schedule that addresses the schedule by name (Job.AttachSchedule/DetachSchedule take the name directly) works from this handle, which makes it the only usable form under a WithScript context: ScheduleByNameContext's lookup is a real read, so a schedule whose sp_add_schedule was merely collected is not there to find.
func (*Server) ScheduleByName ¶ added in v0.0.6
ScheduleByName returns a single schedule by name.
func (*Server) ScheduleByNameContext ¶ added in v0.0.6
ScheduleByNameContext is the context-aware variant of ScheduleByName.
func (*Server) ScheduleSeq ¶ added in v0.0.6
ScheduleSeq returns an iterator over all SQL Server Agent schedules.
func (*Server) Schedules ¶ added in v0.0.6
Schedules returns every SQL Server Agent schedule defined on the server.
func (*Server) SchedulesContext ¶ added in v0.0.6
SchedulesContext is the context-aware variant of Schedules.
func (*Server) SecurityInfo ¶ added in v0.0.4
func (s *Server) SecurityInfo() (*ServerSecurityInfo, error)
SecurityInfo returns server-wide authentication settings.
func (*Server) SecurityInfoContext ¶ added in v0.0.4
func (s *Server) SecurityInfoContext(ctx context.Context) (*ServerSecurityInfo, error)
SecurityInfoContext is the context-aware variant of SecurityInfo.
func (*Server) SendMailContext ¶
func (s *Server) SendMailContext(ctx context.Context, profile, recipients, subject, body string) error
SendMailContext is the context-aware variant of SendMail.
func (*Server) ServerPermissionSeq ¶ added in v0.0.4
ServerPermissionSeq returns an iterator over all server-level GRANT/DENY entries.
func (*Server) ServerPermissions ¶ added in v0.0.4
func (s *Server) ServerPermissions() ([]*ServerPermissionEntry, error)
ServerPermissions returns every server-level GRANT/DENY entry.
func (*Server) ServerPermissionsContext ¶ added in v0.0.4
func (s *Server) ServerPermissionsContext(ctx context.Context) ([]*ServerPermissionEntry, error)
ServerPermissionsContext is the context-aware variant of ServerPermissions.
func (*Server) ServerRoleByName ¶ added in v0.0.6
func (s *Server) ServerRoleByName(name string) (*ServerRole, error)
ServerRoleByName returns a single server role by name, with its principal detail (SID, create/modify dates) filled in — ServerRolesContext leaves these out since Object Explorer's tree listing never needs them.
func (*Server) ServerRoleByNameContext ¶ added in v0.0.6
ServerRoleByNameContext is the context-aware variant of ServerRoleByName.
func (*Server) ServerRoleMemberSeq ¶ added in v0.0.6
func (s *Server) ServerRoleMemberSeq(ctx context.Context, roleName string) iter.Seq2[*RoleMember, error]
ServerRoleMemberSeq returns an iterator over a server role's members.
func (*Server) ServerRoleMembers ¶ added in v0.0.6
func (s *Server) ServerRoleMembers(roleName string) ([]*RoleMember, error)
ServerRoleMembers returns the direct members of a server role (logins or other server roles), with each member's principal type — ServerRolesContext/ServerRoleByNameContext only return member names, concatenated, with no type.
func (*Server) ServerRoleMembersContext ¶ added in v0.0.6
func (s *Server) ServerRoleMembersContext(ctx context.Context, roleName string) ([]*RoleMember, error)
ServerRoleMembersContext is the context-aware variant of ServerRoleMembers.
func (*Server) ServerRoleSeq ¶ added in v0.0.6
ServerRoleSeq returns an iterator over all server-level roles.
func (*Server) ServerRoles ¶
func (s *Server) ServerRoles() ([]*ServerRole, error)
ServerRoles returns all fixed and user-defined server roles.
func (*Server) ServerRolesContext ¶
func (s *Server) ServerRolesContext(ctx context.Context) ([]*ServerRole, error)
ServerRolesContext is the context-aware variant of ServerRoles.
func (*Server) VerifyBackup ¶ added in v0.0.5
VerifyBackup checks that the backup set on device is complete and readable (RESTORE VERIFYONLY), without restoring it.
type ServerInfo ¶
type ServerInfo struct {
Name string
Edition string
ProductVersion string
ProductLevel string
VersionMajor int
VersionMinor int
VersionBuild int
Collation string
IsClustered bool
IsHADREnabled bool
IsSingleUser bool
EngineEdition int
OSVersion string
// Platform is the host operating system family — "Windows" or "Linux" —
// derived from @@VERSION rather than sys.dm_os_host_info so it is
// populated on pre-2017 instances too. Empty if @@VERSION names neither.
Platform string
MaxConnections int
// PhysicalMemoryMB and LogicalCPUCount come from sys.dm_os_sys_info and
// are zero when SysInfoUnavailable is set. Read that flag before showing
// either: zero there means "not readable", not "none".
PhysicalMemoryMB int64
LogicalCPUCount int
// leaving PhysicalMemoryMB and LogicalCPUCount at zero. The usual cause
// is a login without VIEW SERVER STATE (VIEW SERVER PERFORMANCE STATE on
// SQL Server 2022 and later), which every other field here survives — a
// db_owner with no server-level rights connects fine and gets everything
// but these two.
SysInfoUnavailable bool
DefaultDataPath string
DefaultLogPath string
DefaultBackupPath string
}
ServerInfo holds basic information about the connected SQL Server instance.
type ServerMemoryStats ¶ added in v0.0.4
type ServerMemoryStats struct {
PhysicalMemoryMB int64
AvailableMemoryMB int64
TargetServerMemoryMB int64
TotalServerMemoryMB int64
}
ServerMemoryStats holds live memory figures for the Server Properties > Memory page's "Current values" section — unlike the configured min/max server memory (an sp_configure option, see ConfigurationOption), these reflect the server's actual memory state right now.
type ServerPermissionEntry ¶ added in v0.0.4
type ServerPermissionEntry struct {
Principal string
PrincipalType string // e.g. "SQL_LOGIN", "SERVER_ROLE"
Grantor string
Permission string // e.g. "CONNECT SQL", "ALTER ANY LOGIN", "CONTROL SERVER"
State string // "GRANT", "GRANT_WITH_GRANT_OPTION", "DENY"
}
ServerPermissionEntry is one GRANT/DENY entry recorded at server scope, as reported by sys.server_permissions — SSMS's Server Properties > Permissions page and a Login's Securables page.
type ServerRole ¶
type ServerRole struct {
Name string
ID int
IsFixedRole bool
Owner string
Members []string
SID []byte
CreateDate time.Time
ModifyDate time.Time
// contains filtered or unexported fields
}
ServerRole represents a server-level role.
func (*ServerRole) ChangeOwner ¶ added in v0.0.6
func (r *ServerRole) ChangeOwner(newOwner string) error
ChangeOwner transfers ownership of the server role to a new principal.
func (*ServerRole) ChangeOwnerContext ¶ added in v0.0.6
func (r *ServerRole) ChangeOwnerContext(ctx context.Context, newOwner string) error
ChangeOwnerContext is the context-aware variant of ChangeOwner.
func (*ServerRole) Drop ¶ added in v0.0.9
func (r *ServerRole) Drop() error
Drop drops this server role.
func (*ServerRole) DropContext ¶ added in v0.0.9
func (r *ServerRole) DropContext(ctx context.Context) error
DropContext is the context-aware variant of Drop.
func (*ServerRole) Rename ¶ added in v0.0.6
func (r *ServerRole) Rename(newName string) error
Rename changes the server role's name.
func (*ServerRole) RenameContext ¶ added in v0.0.6
func (r *ServerRole) RenameContext(ctx context.Context, newName string) error
RenameContext is the context-aware variant of Rename.
type ServerScripter ¶ added in v0.0.10
type ServerScripter struct {
// contains filtered or unexported fields
}
ServerScripter generates T-SQL scripts for server-level objects, the ones that belong to no database: logins and server roles. Scripter's objects all live inside a Database, which is why these are not on it.
func NewServerScripter ¶ added in v0.0.10
func NewServerScripter(s *Server, opts ScriptOptions) *ServerScripter
NewServerScripter creates a ServerScripter for the given server.
func (*ServerScripter) ScriptLogin ¶ added in v0.0.10
func (sc *ServerScripter) ScriptLogin(name string) (string, error)
ScriptLogin generates the CREATE (or DROP) script for one login.
func (*ServerScripter) ScriptLoginContext ¶ added in v0.0.10
ScriptLoginContext is the context-aware variant of ScriptLogin.
A certificate- or asymmetric-key-mapped login needs one more read than the others: the object it maps to is named in master, not in the login's own row. ResolveMappingContext is a no-op for every other type.
func (*ServerScripter) ScriptServerRole ¶ added in v0.0.10
func (sc *ServerScripter) ScriptServerRole(name string) (string, error)
ScriptServerRole generates the CREATE (or DROP) script for one server role, including the ALTER SERVER ROLE statements that restore its membership.
func (*ServerScripter) ScriptServerRoleContext ¶ added in v0.0.10
ScriptServerRoleContext is the context-aware variant of ScriptServerRole.
type ServerSecurityInfo ¶ added in v0.0.4
type ServerSecurityInfo struct {
// AuthenticationMode is "WINDOWS" (Windows Authentication only) or
// "MIXED" (SQL Server and Windows Authentication).
AuthenticationMode string
}
ServerSecurityInfo holds server-wide authentication settings — SSMS's Server Properties > Security page. Login-audit level and the server proxy account live in the registry (xp_instance_regread), which gosmo deliberately does not touch (see README "Features intentionally excluded"); only what SERVERPROPERTY exposes is included here.
type ServerVersion ¶
type ServerVersion int
ServerVersion represents a SQL Server version.
const ( SQLServer2012 ServerVersion = 11 SQLServer2014 ServerVersion = 12 SQLServer2016 ServerVersion = 13 SQLServer2017 ServerVersion = 14 SQLServer2019 ServerVersion = 15 SQLServer2022 ServerVersion = 16 )
type SpaceInfo ¶
type SpaceInfo struct {
TotalMB float64
DataMB float64
LogMB float64
// UnallocatedMB is free space within the database's already-allocated
// data files (SSMS's Database Properties > General "Space available"),
// not free disk space — it can only shrink the database's on-disk
// footprint, not grow it, without a file autogrowth event.
UnallocatedMB float64
// AvailLogMB is the same free-space measure as UnallocatedMB, but for
// the log file(s) rather than the data file(s).
AvailLogMB float64
}
SpaceInfo holds space usage information for a database.
type SpatialBoundingBox ¶ added in v0.0.10
type SpatialBoundingBox struct {
XMin, YMin, XMax, YMax float64
}
SpatialBoundingBox is the rectangle a geometry index tessellates (BOUNDING_BOX). Anything outside it lands in the single top-level cell, so it belongs around the data, not around the coordinate system.
type SpatialGridDensity ¶ added in v0.0.10
type SpatialGridDensity string
SpatialGridDensity is one grid level's density in a GRIDS clause.
const ( SpatialGridLow SpatialGridDensity = "LOW" SpatialGridMedium SpatialGridDensity = "MEDIUM" SpatialGridHigh SpatialGridDensity = "HIGH" )
type SpatialGridLevels ¶ added in v0.0.10
type SpatialGridLevels struct {
Level1, Level2, Level3, Level4 SpatialGridDensity
}
SpatialGridLevels is a spatial index's per-level grid density (GRIDS). A level left empty is omitted from the clause and takes the server's default, so the zero value means "no GRIDS clause at all".
type SpatialTessellation ¶ added in v0.0.10
type SpatialTessellation string
SpatialTessellation is a spatial index's tessellation scheme — the USING clause of CREATE SPATIAL INDEX. The GEOMETRY_ schemes apply to a geometry column and the GEOGRAPHY_ ones to a geography column; the server rejects the mismatch.
const ( SpatialGeometryGrid SpatialTessellation = "GEOMETRY_GRID" SpatialGeometryAutoGrid SpatialTessellation = "GEOMETRY_AUTO_GRID" SpatialGeographyGrid SpatialTessellation = "GEOGRAPHY_GRID" SpatialGeographyAutoGrid SpatialTessellation = "GEOGRAPHY_AUTO_GRID" )
func (SpatialTessellation) IsAutoGrid ¶ added in v0.0.10
func (s SpatialTessellation) IsAutoGrid() bool
IsAutoGrid reports whether s is one of the automatic schemes, which pick their own grid densities and so take no GRIDS clause.
func (SpatialTessellation) IsGeometry ¶ added in v0.0.10
func (s SpatialTessellation) IsGeometry() bool
IsGeometry reports whether s tessellates a geometry column, the two schemes that take a bounding box.
type Statistic ¶
type Statistic struct {
Name string
StatID int
IsAutoCreated bool
IsUserCreated bool
HasFilter bool
FilterDef string
LastUpdated time.Time
RowsSampled int64
TotalRows int64 // renamed from RowCount to avoid shadowing Table.RowCount()
Steps int
UnfilteredRows int64
NoRecompute bool
IsIncremental bool
ModificationCounter int64
// contains filtered or unexported fields
}
Statistic mirrors sys.stats for a table.
func (*Statistic) ColumnSeq ¶ added in v0.0.6
ColumnSeq returns an iterator over this statistic's columns, in stat-column order.
func (*Statistic) Columns ¶ added in v0.0.6
Columns returns this statistic's columns, in stat-column order. The leading column is what the statistic's histogram is built on; every column contributes to its density vector.
func (*Statistic) ColumnsContext ¶ added in v0.0.6
ColumnsContext is the context-aware variant of Columns.
func (*Statistic) DensityVector ¶ added in v0.0.6
func (st *Statistic) DensityVector() ([]*StatisticDensity, error)
DensityVector returns this statistic's density vector.
func (*Statistic) DensityVectorContext ¶ added in v0.0.6
func (st *Statistic) DensityVectorContext(ctx context.Context) ([]*StatisticDensity, error)
DensityVectorContext is the context-aware variant of DensityVector.
func (*Statistic) DensityVectorSeq ¶ added in v0.0.6
DensityVectorSeq returns an iterator over this statistic's density vector.
func (*Statistic) Drop ¶
Drop drops this statistic. Correct T-SQL syntax: DROP STATISTICS table_name.stat_name
func (*Statistic) DropContext ¶
DropContext is the context-aware variant of Drop.
func (*Statistic) Header ¶ added in v0.0.6
func (st *Statistic) Header() (*StatisticHeader, error)
Header returns this statistic's DBCC SHOW_STATISTICS header row.
func (*Statistic) HeaderContext ¶ added in v0.0.6
func (st *Statistic) HeaderContext(ctx context.Context) (*StatisticHeader, error)
HeaderContext is the context-aware variant of Header.
func (*Statistic) Histogram ¶ added in v0.0.6
func (st *Statistic) Histogram() ([]*StatisticHistogramStep, error)
Histogram returns this statistic's histogram steps.
func (*Statistic) HistogramContext ¶ added in v0.0.6
func (st *Statistic) HistogramContext(ctx context.Context) ([]*StatisticHistogramStep, error)
HistogramContext is the context-aware variant of Histogram.
func (*Statistic) HistogramSeq ¶ added in v0.0.6
HistogramSeq returns an iterator over this statistic's histogram steps.
func (*Statistic) RenameContext ¶ added in v0.0.9
RenameContext is the context-aware variant of Rename.
type StatisticDensity ¶ added in v0.0.6
StatisticDensity is one row of DBCC SHOW_STATISTICS ... WITH DENSITY_VECTOR — one row per leading-column prefix of the statistic's key columns (e.g. a 2-column statistic yields 2 rows: {col1} and {col1,col2}).
type StatisticHeader ¶ added in v0.0.6
type StatisticHeader struct {
Updated string
Rows int64
RowsSampled int64
Steps int
Density float64
AverageKeyLength float64
StringIndex string
FilterExpression string
UnfilteredRows int64
PersistedSamplePercent float64
}
StatisticHeader mirrors the single result row of DBCC SHOW_STATISTICS ... WITH STAT_HEADER. Every field is zero-valued (Updated "") when the statistic exists as metadata but has never actually been populated (e.g. an auto-created statistic on a table nothing has queried yet) — SQL Server itself returns a header row of NULLs in that case.
type StatisticHistogramStep ¶ added in v0.0.6
type StatisticHistogramStep struct {
RangeHighKey string
RangeRows float64
EqRows float64
DistinctRangeRows int64
AvgRangeRows float64
}
StatisticHistogramStep is one step of DBCC SHOW_STATISTICS ... WITH HISTOGRAM. RangeHighKey is formatted as text since its underlying SQL type follows the statistic's leading key column (int, varchar, datetime, ...), not one fixed Go type.
type StoredProcedure ¶
type StoredProcedure struct {
ObjectID int
Schema string
Name string
Definition string
CreateDate time.Time
ModifyDate time.Time
}
StoredProcedure represents a stored procedure.
type Synonym ¶
type Synonym struct {
Name string
Schema string
ObjectID int
BaseObject string // fully qualified base object name
// contains filtered or unexported fields
}
Synonym mirrors sys.synonyms.
type Table ¶
type Table struct {
ObjectID int
Schema string
Name string
CreateDate time.Time
ModifyDate time.Time
HasReplicationFilter bool
IsMemoryOptimized bool
// contains filtered or unexported fields
}
Table mirrors Microsoft.SqlServer.Management.Smo.Table.
func (*Table) AlterColumn ¶ added in v0.0.4
func (t *Table) AlterColumn(col ColumnDefinition) error
AlterColumn changes an existing column's data type and/or nullability (ALTER TABLE ... ALTER COLUMN). Identity and default are not settable this way — SQL Server requires dropping and re-adding the column, or its default constraint, for those.
func (*Table) AlterColumnContext ¶ added in v0.0.4
func (t *Table) AlterColumnContext(ctx context.Context, col ColumnDefinition) error
AlterColumnContext is the context-aware variant of AlterColumn.
func (*Table) CheckConstraintSeq ¶ added in v0.0.6
CheckConstraintSeq returns an iterator over all CHECK constraints on the table.
func (*Table) CheckConstraints ¶
func (t *Table) CheckConstraints() ([]*CheckConstraint, error)
CheckConstraints returns all CHECK constraints on the table.
func (*Table) CheckConstraintsContext ¶
func (t *Table) CheckConstraintsContext(ctx context.Context) ([]*CheckConstraint, error)
CheckConstraintsContext is the context-aware variant of CheckConstraints.
func (*Table) CheckWhereSyntax ¶ added in v0.0.6
CheckWhereSyntax validates a WHERE predicate against the table without scanning any data (SSMS's "Check Syntax" action for a filtered index or statistic's predicate).
func (*Table) CheckWhereSyntaxContext ¶ added in v0.0.6
CheckWhereSyntaxContext is the context-aware variant of CheckWhereSyntax.
func (*Table) ColumnSeq ¶
ColumnSeq returns an iterator over all columns in the table, in ordinal order.
func (*Table) ColumnsContext ¶
ColumnsContext is the context-aware variant of Columns.
func (*Table) CountWhere ¶ added in v0.0.6
CountWhere returns the number of rows in the table matching a WHERE predicate — used to estimate qualifying rows for a filtered index or filtered statistic's predicate (SSMS's "Estimate Rows" action).
func (*Table) CountWhereContext ¶ added in v0.0.6
CountWhereContext is the context-aware variant of CountWhere. predicate is interpolated as-is after WHERE; callers pass a filter expression already captured from the server (e.g. an index or statistic's own FilterDefinition), not raw user input.
func (*Table) CreateIndex ¶
func (t *Table) CreateIndex(req CreateIndexRequest) error
CreateIndex creates a new index on the table.
func (*Table) CreateIndexContext ¶
func (t *Table) CreateIndexContext(ctx context.Context, req CreateIndexRequest) error
CreateIndexContext is the context-aware variant of CreateIndex.
func (*Table) CreateStatistic ¶
CreateStatistic creates a user-defined statistic on one or more columns. Pass samplePct=0 to let the server choose its own sample; see CreateStatisticWithOptions for a filter, FULLSCAN, or NORECOMPUTE.
func (*Table) CreateStatisticContext ¶
func (t *Table) CreateStatisticContext(ctx context.Context, name string, columns []string, samplePct int) error
CreateStatisticContext is the context-aware variant of CreateStatistic.
func (*Table) CreateStatisticWithOptions ¶ added in v0.0.10
func (t *Table) CreateStatisticWithOptions(req CreateStatisticRequest) error
CreateStatisticWithOptions creates a user-defined statistic from a full request — the form that reaches the sampling, filter and recompute options CreateStatistic leaves at their defaults.
func (*Table) CreateStatisticWithOptionsContext ¶ added in v0.0.10
func (t *Table) CreateStatisticWithOptionsContext(ctx context.Context, req CreateStatisticRequest) error
CreateStatisticWithOptionsContext is the context-aware variant of CreateStatisticWithOptions.
func (*Table) DataSpace ¶ added in v0.0.10
DataSpace returns where the table itself stores its rows — the filegroup or partition scheme its heap or clustered index is on, which is CREATE TABLE's ON clause.
func (*Table) DataSpaceContext ¶ added in v0.0.10
DataSpaceContext is the context-aware variant of DataSpace.
Read from index_id 0 or 1, so it answers for a heap as well as a clustered table — which is why it is a query of its own rather than a field of the index list, whose `i.type > 0` filter has no heap in it.
A table with no row there at all — a Database.Table handle, whose ObjectID is zero, or a memory-optimized table — reads as the zero DataSpace and no error: absence means "no filegroup to name", not a failure.
func (*Table) Detail ¶ added in v0.0.5
func (t *Table) Detail() (*TableDetail, error)
Detail returns TableDetail for the table.
func (*Table) DetailContext ¶ added in v0.0.5
func (t *Table) DetailContext(ctx context.Context) (*TableDetail, error)
DetailContext is the context-aware variant of Detail.
func (*Table) DropColumn ¶ added in v0.0.4
DropColumn removes a column from the table (ALTER TABLE ... DROP COLUMN).
Bare, like every other Drop in this package: SQL Server refuses a column a default constraint, index, check constraint or statistic depends on, and that refusal is the answer — dropping the dependencies first is a decision the caller makes, not one a library can make for them. The data in the column goes with it and is not recoverable.
func (*Table) DropColumnContext ¶ added in v0.0.4
DropColumnContext is the context-aware variant of DropColumn.
func (*Table) DropConstraint ¶ added in v0.0.9
DropConstraint drops a named table constraint — a PRIMARY KEY, UNIQUE constraint, FOREIGN KEY, or CHECK constraint. All four share one per-table name space and are all removed by ALTER TABLE ... DROP CONSTRAINT; an index that is not backing a key constraint is not a constraint and needs Index.Drop instead.
func (*Table) DropConstraintContext ¶ added in v0.0.9
DropConstraintContext is the context-aware variant of DropConstraint.
func (*Table) ForeignKeyByName ¶ added in v0.0.10
func (t *Table) ForeignKeyByName(name string) (*ForeignKey, error)
ForeignKeyByName returns one foreign key on the table by name.
func (*Table) ForeignKeyByNameContext ¶ added in v0.0.10
ForeignKeyByNameContext is the context-aware variant of ForeignKeyByName. It returns an error satisfying errors.Is(err, ErrNotFound) when the table has no such foreign key.
func (*Table) ForeignKeySeq ¶
ForeignKeySeq returns an iterator over all foreign keys on the table.
func (*Table) ForeignKeys ¶
func (t *Table) ForeignKeys() ([]*ForeignKey, error)
ForeignKeys returns all foreign keys on the table.
func (*Table) ForeignKeysContext ¶
func (t *Table) ForeignKeysContext(ctx context.Context) ([]*ForeignKey, error)
ForeignKeysContext is the context-aware variant of ForeignKeys.
func (*Table) FragmentationStats ¶
func (t *Table) FragmentationStats(mode string) ([]*IndexFragmentation, error)
FragmentationStats returns fragmentation info for all indexes on the table. mode must be one of "LIMITED" (fast, default), "SAMPLED", or "DETAILED".
func (*Table) FragmentationStatsContext ¶
func (t *Table) FragmentationStatsContext(ctx context.Context, mode string) ([]*IndexFragmentation, error)
FragmentationStatsContext is the context-aware variant of FragmentationStats.
func (*Table) FragmentationStatsSeq ¶ added in v0.0.6
func (t *Table) FragmentationStatsSeq(ctx context.Context, mode string) iter.Seq2[*IndexFragmentation, error]
FragmentationStatsSeq returns an iterator over fragmentation info for all indexes on the table. mode must be one of "LIMITED" (fast, default), "SAMPLED", or "DETAILED".
func (*Table) IndexByName ¶ added in v0.0.10
IndexByName returns one index on the table by name, with its columns.
func (*Table) IndexByNameContext ¶ added in v0.0.10
IndexByNameContext is the context-aware variant of IndexByName. It returns an error satisfying errors.Is(err, ErrNotFound) when the table has no such index. Two queries, the same shape as IndexesContext — see its comment for why the columns are not fetched inside the index scan.
func (*Table) IndexesContext ¶
IndexesContext is the context-aware variant of Indexes.
Two queries, whatever the index count: one for the indexes, one for every index column on the object at once. Fetching each index's columns inside the loop over the indexes cost a query per index, and Database.query pins its own pooled connection and issues its own USE, so a table with 20 indexes ran 42 round trips across 21 connections — with the outer one held throughout, which is the shape that exhausts a pool rather than merely being slow.
func (*Table) PartitionSeq ¶ added in v0.0.5
PartitionSeq returns an iterator over per-partition row counts for the table.
func (*Table) Partitions ¶
func (t *Table) Partitions() ([]*PartitionInfo, error)
Partitions returns per-partition row counts and compression for the table.
func (*Table) PartitionsContext ¶ added in v0.0.5
func (t *Table) PartitionsContext(ctx context.Context) ([]*PartitionInfo, error)
PartitionsContext is the context-aware variant of Partitions. A non-partitioned table still returns exactly one row (partition number 1), same as sys.partitions itself.
func (*Table) RebuildAllIndexes ¶
RebuildAllIndexes rebuilds all indexes on the table (ALTER INDEX ALL ... REBUILD).
func (*Table) RebuildAllIndexesContext ¶
RebuildAllIndexesContext is the context-aware variant of RebuildAllIndexes.
func (*Table) RenameColumn ¶ added in v0.0.10
RenameColumn renames a column using sp_rename's 'COLUMN' class.
Bare, like the rest of this family: sp_rename does not update anything that names the column. Views, procedures, functions, computed columns, indexes with a filter predicate and check constraints keep the old name in their definitions and break at their next use, and SQL Server reports nothing at rename time beyond its standing caution. Deciding whether that is acceptable is the caller's.
newName is a bare name: sp_rename refuses a qualified one for the new name, while @objname must be the three-part table.column form, which this builds.
func (*Table) RenameColumnContext ¶ added in v0.0.10
RenameColumnContext is the context-aware variant of RenameColumn.
func (*Table) RowCountContext ¶
RowCountContext is the context-aware variant of RowCount.
func (*Table) SpaceUsed ¶ added in v0.0.5
func (t *Table) SpaceUsed() (*TableSpaceInfo, error)
SpaceUsed returns space usage for the table.
func (*Table) SpaceUsedContext ¶ added in v0.0.5
func (t *Table) SpaceUsedContext(ctx context.Context) (*TableSpaceInfo, error)
SpaceUsedContext is the context-aware variant of SpaceUsed.
func (*Table) StatisticByName ¶ added in v0.0.10
StatisticByName returns one statistics object on the table by name.
func (*Table) StatisticByNameContext ¶ added in v0.0.10
StatisticByNameContext is the context-aware variant of StatisticByName. It returns an error satisfying errors.Is(err, ErrNotFound) when the table has no such statistic.
func (*Table) StatisticSeq ¶
StatisticSeq returns an iterator over all statistics on the table.
func (*Table) Statistics ¶
Statistics returns all statistics objects for the table.
func (*Table) StatisticsContext ¶
StatisticsContext is the context-aware variant of Statistics.
func (*Table) TriggerSeq ¶ added in v0.0.4
TriggerSeq returns an iterator over all DML triggers attached to the table.
func (*Table) TriggersContext ¶ added in v0.0.4
TriggersContext is the context-aware variant of Triggers.
func (*Table) TruncateTable ¶
TruncateTable truncates a table.
func (*Table) TruncateTableContext ¶
TruncateTableContext is the context-aware variant of TruncateTable.
func (*Table) UpdateAllStatistics ¶
UpdateAllStatistics updates all statistics on the table.
func (*Table) UpdateAllStatisticsContext ¶
UpdateAllStatisticsContext is the context-aware variant of UpdateAllStatistics.
func (*Table) XMLIndexSeq ¶ added in v0.0.10
XMLIndexSeq returns an iterator over all XML indexes on the table.
func (*Table) XMLIndexes ¶ added in v0.0.10
XMLIndexes returns the XML indexes on the table, primary and secondary, in name order.
type TableChangeTracking ¶ added in v0.0.4
TableChangeTracking describes one user table's change tracking state.
type TableDetail ¶ added in v0.0.5
type TableDetail struct {
SchemaOwner string
LockEscalation string // e.g. "TABLE", "AUTO", "DISABLE"
UsesAnsiNulls bool
IsReplicated bool
IsTrackedByCDC bool
TemporalType string // e.g. "NON_TEMPORAL_TABLE", "SYSTEM_VERSIONED_TEMPORAL_TABLE"
Durability string // "SCHEMA_AND_DATA" or "SCHEMA_ONLY" — memory-optimized tables only
LedgerType string // e.g. "NON_LEDGER_TABLE", "APPEND_ONLY_LEDGER_TABLE"
PrimaryKeyName string // "" if the table has no primary key
DataSpace string // filegroup (or partition scheme) backing the heap/clustered index
}
TableDetail holds the sys.tables columns and related lookups Table itself doesn't carry (Table is also used to populate the Object Explorer tree and the scripter, so it stays lean) — SSMS's Table Properties > General page's "Object details" and "Dependencies" sections.
type TableSpaceInfo ¶ added in v0.0.5
type TableSpaceInfo struct {
ReservedKB int64
DataKB int64
IndexKB int64
LOBKB int64
UnusedKB int64
FileGroup string
}
TableSpaceInfo holds space usage for a table (SSMS's Table Properties > Storage page), mirroring the classic sp_spaceused breakdown: DataKB is the heap/clustered index's own row data, IndexKB is every other (nonclustered) index's row data, LOBKB is off-row large-object storage, and UnusedKB is reserved-but-not-yet-used space within already allocated extents.
type TextCriterion ¶ added in v0.0.10
TextCriterion is one comparison against a name or schema.
type Trigger ¶
type Trigger struct {
Name string
TableName string
Schema string
IsEnabled bool
Events []string
Definition string
}
Trigger represents a DML trigger attached to a table.
type User ¶
type User struct {
Name string
ID int
UserType string // "SQL_USER", "WINDOWS_USER", "WINDOWS_GROUP", etc.
DefaultSchema string
AuthType string
CreateDate time.Time
ModifyDate time.Time
SID []byte
// LoginName is the server login this user's SID matches, or empty if
// none does — only populated by UserByNameContext (UsersContext's
// tree-listing query doesn't join sys.server_principals). A blank
// LoginName is ambiguous by itself: check AuthType too. A genuine
// CREATE USER ... WITHOUT LOGIN reports AuthType "NONE", while a user
// created FOR LOGIN whose login was later dropped keeps AuthType
// "INSTANCE" with no matching login, i.e. orphaned.
LoginName string
// LoginDisabled is only meaningful when LoginName is non-empty.
LoginDisabled bool
// contains filtered or unexported fields
}
User mirrors Microsoft.SqlServer.Management.Smo.User.
func (*User) AddToRoleContext ¶ added in v0.0.6
AddToRoleContext is the context-aware variant of AddToRole.
func (*User) Deny ¶
func (u *User) Deny(permission ObjectPermission, objectSchema, objectName string) error
Deny denies a permission on a schema-qualified object to the user.
func (*User) DenyContext ¶
func (u *User) DenyContext(ctx context.Context, permission ObjectPermission, objectSchema, objectName string) error
DenyContext is the context-aware variant of Deny.
func (*User) DropContext ¶ added in v0.0.6
DropContext is the context-aware variant of Drop.
func (*User) Grant ¶
func (u *User) Grant(permission ObjectPermission, objectSchema, objectName string) error
Grant grants a permission on a schema-qualified object to the user.
func (*User) GrantContext ¶
func (u *User) GrantContext(ctx context.Context, permission ObjectPermission, objectSchema, objectName string) error
GrantContext is the context-aware variant of Grant.
func (*User) RemoveFromRole ¶
RemoveFromRole removes the user from a database role.
func (*User) RemoveFromRoleContext ¶ added in v0.0.6
RemoveFromRoleContext is the context-aware variant of RemoveFromRole.
func (*User) RenameContext ¶ added in v0.0.5
RenameContext is the context-aware variant of Rename.
func (*User) Revoke ¶
func (u *User) Revoke(permission ObjectPermission, objectSchema, objectName string) error
Revoke revokes a permission on a schema-qualified object from the user.
func (*User) RevokeContext ¶
func (u *User) RevokeContext(ctx context.Context, permission ObjectPermission, objectSchema, objectName string) error
RevokeContext is the context-aware variant of Revoke.
func (*User) SetDefaultSchema ¶ added in v0.0.5
SetDefaultSchema changes the user's default schema.
func (*User) SetDefaultSchemaContext ¶ added in v0.0.5
SetDefaultSchemaContext is the context-aware variant of SetDefaultSchema.
type UserDefinedFunction ¶
type UserDefinedFunction struct {
ObjectID int
Schema string
Name string
FuncType string // "FN" scalar, "TF" multi-statement table-valued, "IF" inline table-valued
Definition string
CreateDate time.Time
ModifyDate time.Time
}
UserDefinedFunction represents a UDF.
type View ¶
type View struct {
ObjectID int
Schema string
Name string
Definition string
CreateDate time.Time
ModifyDate time.Time
}
View represents a database view.
type XMLIndex ¶ added in v0.0.10
type XMLIndex struct {
Name string
IndexID int
// IsPrimary is true for a primary XML index, which is the one built
// directly on the xml column; a secondary index is built over it.
IsPrimary bool
// SecondaryType is PATH, VALUE or PROPERTY for a secondary index, and
// empty for a primary one.
SecondaryType XMLSecondaryIndexType
// ColumnName is the xml column the index is on.
ColumnName string
// PrimaryIndexName is the primary XML index a secondary one is built
// over, and empty for a primary index.
PrimaryIndexName string
}
XMLIndex is one XML index on a table — sys.xml_indexes. It carries what sys.indexes cannot: whether the index is the table's primary XML index or a secondary one, which secondary form it is, and which primary index it is built over. A secondary XML index can only be created over an existing primary one, so a caller offering to create one has to know which primary indexes are there.
type XMLSecondaryIndexType ¶ added in v0.0.10
type XMLSecondaryIndexType string
XMLSecondaryIndexType selects which secondary XML index CREATE XML INDEX builds — the FOR clause. A secondary index is always built over an existing primary XML index (see CreateIndexRequest).
const ( // XMLSecondaryPath indexes path/value pairs, for predicates on a path. XMLSecondaryPath XMLSecondaryIndexType = "PATH" // XMLSecondaryValue indexes value/path pairs, for predicates whose path // is a wildcard or a descendant axis. XMLSecondaryValue XMLSecondaryIndexType = "VALUE" // XMLSecondaryProperty indexes primary-key/path/value triples, for // property-bag retrieval of one row's values. XMLSecondaryProperty XMLSecondaryIndexType = "PROPERTY" )
Source Files
¶
- agent_alert.go
- agent_category.go
- agent_job.go
- agent_operator.go
- agent_schedule.go
- auth.go
- availability_group.go
- azuread_import.go
- backup.go
- bulkcopy.go
- capabilities.go
- catalog.go
- certificate.go
- change_tracking.go
- column_permission.go
- database.go
- database_files.go
- database_options.go
- database_role.go
- database_scoped_config.go
- dependency.go
- effective_permission.go
- endpoint.go
- error_log.go
- errors.go
- executionplan.go
- extended_properties.go
- filesystem.go
- function.go
- helpers.go
- index.go
- iter.go
- kerberos.go
- login.go
- object_filter.go
- partition.go
- permission_options.go
- procedure.go
- query_store.go
- quoting.go
- retry.go
- schema_user.go
- script.go
- scripter.go
- scripter_dml.go
- scripter_objects.go
- scripter_security.go
- scripter_server.go
- search.go
- securable_search.go
- security.go
- sequence_synonym.go
- server.go
- server_config.go
- server_security.go
- statistics.go
- table.go
- types.go
- view.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Command examples is a guided tour of gosmo: connect, inspect the instance, build a throwaway database with schemas, tables, indexes, a sequence and a procedure, script it, then drop it again.
|
Command examples is a guided tour of gosmo: connect, inspect the instance, build a throwaway database with schemas, tables, indexes, a sequence and a procedure, script it, then drop it again. |
|
backup
command
Command backup demonstrates gosmo's backup and restore surface: a full backup with live progress reporting, reading a backup device's headers and file list, verifying it, a differential and a log backup appended to the same media, the backup history in msdb, and a restore that relocates the database's files.
|
Command backup demonstrates gosmo's backup and restore surface: a full backup with live progress reporting, reading a backup device's headers and file list, verifying it, a differential and a log backup appended to the same media, the backup history in msdb, and a restore that relocates the database's files. |
|
bulkcopy
command
Command bulkcopy demonstrates Database.BulkInsert — gosmo's bcp-equivalent load path.
|
Command bulkcopy demonstrates Database.BulkInsert — gosmo's bcp-equivalent load path. |
|
diagnostic
command
Command diagnostic demonstrates the parts of gosmo you reach for when something is wrong or you are exploring an unfamiliar instance: structured SQL Server errors, the transient-failure test, execution plans, calling procedures with output parameters, object search and dependency graphs, the bulk catalog snapshot, and the server-health DMV reads.
|
Command diagnostic demonstrates the parts of gosmo you reach for when something is wrong or you are exploring an unfamiliar instance: structured SQL Server errors, the transient-failure test, execution plans, calling procedures with output parameters, object search and dependency graphs, the bulk catalog snapshot, and the server-health DMV reads. |
|
internal/demo
Package demo holds the connection factory and output helpers the gosmo example programs share, so each example file is only about its own topic.
|
Package demo holds the connection factory and output helpers the gosmo example programs share, so each example file is only about its own topic. |
|
iterators
command
Command iterators demonstrates gosmo's *Seq API.
|
Command iterators demonstrates gosmo's *Seq API. |
|
jobs
command
Command jobs demonstrates gosmo's SQL Server Agent surface: categories, operators, a job with several steps and branching, a shared schedule attached to it, running it, reading its history, and alerts.
|
Command jobs demonstrates gosmo's SQL Server Agent surface: categories, operators, a job with several steps and branching, a shared schedule attached to it, running it, reading its history, and alerts. |
|
maintain
command
Command maintain demonstrates the routine-maintenance side of gosmo: index fragmentation and rebuilds, statistics with their header, histogram and density vector, database files and filegroups, space usage, database options and scoped configurations, change tracking, and Query Store.
|
Command maintain demonstrates the routine-maintenance side of gosmo: index fragmentation and rebuilds, statistics with their header, histogram and density vector, database files and filegroups, space usage, database options and scoped configurations, change tracking, and Query Store. |
|
scripting
command
Command scripting demonstrates the two ways gosmo produces T-SQL text instead of changing the server:
|
Command scripting demonstrates the two ways gosmo produces T-SQL text instead of changing the server: |
|
security
command
Command security demonstrates gosmo's principal and permission surface: creating a login, mapping it into a database as a user, role membership at both levels, granting and denying object/schema/database/server permissions, and reading the permission state back from either direction.
|
Command security demonstrates gosmo's principal and permission surface: creating a login, mapping it into a database as a user, role membership at both levels, granting and denying object/schema/database/server permissions, and reading the permission state back from either direction. |
|
Package version holds gosmo's own version metadata, mirroring the same pattern gossms/internal/version/version.go uses.
|
Package version holds gosmo's own version metadata, mirroring the same pattern gossms/internal/version/version.go uses. |