rds

README

Postgres RDS extension

Purpose

This extension manages Postgres on AWS RDS for staging/prod environments and dynamically switches to incluster Postgres for dev/test environments.

Status

Early access

Ready for experimentation. Not ready for hosting production-grade workloads.

Documentation

Index

• Constants
• Variables
• func ProvideDatabase(ctx context.Context, db *Database, deps ExtensionDeps) (*postgres.DB, error)
• type Database
  • func (*Database) Descriptor() ([]byte, []int)
  • func (x *Database) GetName() string
  • func (x *Database) GetSchemaFile() *types.Resource
  • func (*Database) ProtoMessage()
  • func (x *Database) ProtoReflect() protoreflect.Message
  • func (x *Database) Reset()
  • func (x *Database) String() string
• type ExtensionDeps

Constants

const InclusterEndpointFlag = "rds_postgresql_endpoint"

Variables

var (
	Package__4j13h1 = &core.Package{
		PackageName: "namespacelabs.dev/foundation/universe/db/postgres/rds",
	}

	Provider__4j13h1 = core.Provider{
		Package:     Package__4j13h1,
		Instantiate: makeDeps__4j13h1,
	}
)

var File_universe_db_postgres_rds_provider_proto protoreflect.FileDescriptor

Functions

func ProvideDatabase

func ProvideDatabase(ctx context.Context, db *Database, deps ExtensionDeps) (*postgres.DB, error)

Types

type Database

type Database struct {
	Name       string          `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	SchemaFile *types.Resource `protobuf:"bytes,2,opt,name=schema_file,json=schemaFile,proto3" json:"schema_file,omitempty"`
	// contains filtered or unexported fields
}

func (*Database) Descriptor

func (*Database) Descriptor() ([]byte, []int)

Deprecated: Use Database.ProtoReflect.Descriptor instead.

func (*Database) GetName

func (x *Database) GetName() string

func (*Database) GetSchemaFile

func (x *Database) GetSchemaFile() *types.Resource

func (*Database) ProtoMessage

func (*Database) ProtoMessage()

func (*Database) ProtoReflect

func (x *Database) ProtoReflect() protoreflect.Message

func (*Database) Reset

func (x *Database) Reset()

func (*Database) String

func (x *Database) String() string

type ExtensionDeps

type ExtensionDeps struct {
	ClientFactory client.ClientFactory
	Creds         *gencreds.Creds
	ServerInfo    *types.ServerInfo
	Wire          base.WireDatabase
}

Dependencies that are instantiated once for the lifetime of the extension.