mirror of
https://github.com/turbot/steampipe.git
synced 2026-03-06 06:35:52 -05:00
85 lines
3.1 KiB
Go
85 lines
3.1 KiB
Go
package steampipeconfig
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/turbot/steampipe/pkg/steampipeconfig/modconfig"
|
|
)
|
|
|
|
// ConnectionDataStructVersion is used to force refreshing connections
|
|
// If we need to force a connection refresh (for example if any of the underlying schema generation code changes),
|
|
// updating this version will force all connections to refresh, as the deserialized data will have an old version
|
|
var ConnectionDataStructVersion int64 = 20211125
|
|
|
|
// ConnectionData is a struct containing all details for a connection
|
|
// - the plugin name and checksum, the connection config and options
|
|
// json tags needed as this is stored in the connection state file
|
|
type ConnectionData struct {
|
|
StructVersion int64 `json:"struct_version,omitempty"`
|
|
// the fully qualified name of the plugin
|
|
Plugin string `json:"plugin,omitempty"`
|
|
// the underlying connection object
|
|
Connection *modconfig.Connection `json:"connection,omitempty"`
|
|
// schema mode - static or dynamic
|
|
SchemaMode string `json:"schema_mode,omitempty"`
|
|
// the hash of the connection schema
|
|
SchemaHash string `json:"schema_hash,omitempty"`
|
|
// the creation time of the plugin file (only used for local plugins)
|
|
ModTime time.Time `json:"mod_time"`
|
|
|
|
// legacy properties included for backwards compatibility with v0.13
|
|
LegacyPlugin string `json:"Plugin,omitempty"`
|
|
LegacyConnection *modconfig.Connection `json:"Connection,omitempty"`
|
|
LegacySchemaMode string `json:"SchemaMode,omitempty"`
|
|
LegacySchemaHash string `json:"SchemaHash,omitempty"`
|
|
LegacyModTime time.Time `json:"ModTime,omitempty"`
|
|
}
|
|
|
|
func NewConnectionData(remoteSchema string, connection *modconfig.Connection, creationTime time.Time) *ConnectionData {
|
|
return &ConnectionData{
|
|
StructVersion: ConnectionDataStructVersion,
|
|
Plugin: remoteSchema,
|
|
Connection: connection,
|
|
ModTime: creationTime,
|
|
}
|
|
}
|
|
|
|
// IsValid checks whether the struct was correctly deserialized,
|
|
// by checking if the StructVersion is populated
|
|
func (d *ConnectionData) IsValid() bool {
|
|
return d.StructVersion > 0
|
|
}
|
|
|
|
// MigrateLegacy migrates the legacy properties into new properties
|
|
func (d *ConnectionData) MigrateLegacy() {
|
|
d.StructVersion = ConnectionDataStructVersion
|
|
d.Plugin = d.LegacyPlugin
|
|
d.SchemaMode = d.LegacySchemaMode
|
|
d.SchemaHash = d.LegacySchemaHash
|
|
d.ModTime = d.LegacyModTime
|
|
d.Connection = d.LegacyConnection
|
|
d.Connection.MigrateLegacy()
|
|
}
|
|
|
|
// MaintainLegacy keeps the values of the legacy properties intact while
|
|
// refreshing connections
|
|
func (d *ConnectionData) MaintainLegacy() {
|
|
d.LegacyPlugin = d.Plugin
|
|
d.LegacySchemaMode = d.SchemaMode
|
|
d.LegacySchemaHash = d.SchemaHash
|
|
d.LegacyModTime = d.ModTime
|
|
d.LegacyConnection = d.Connection
|
|
}
|
|
|
|
func (d *ConnectionData) Equals(other *ConnectionData) bool {
|
|
if d.Connection == nil || other.Connection == nil {
|
|
// if either object has a nil Connection, then it may be data from an old connection state file
|
|
// return false, so that connections get refreshed and this file gets written in the new format in the process
|
|
return false
|
|
}
|
|
|
|
return d.Plugin == other.Plugin &&
|
|
d.ModTime.Equal(other.ModTime) &&
|
|
d.Connection.Equals(other.Connection)
|
|
}
|