firestore

Documentation

Index

• Constants
• type Config
  • func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error)
  • func (r Config) SourceConfigKind() string
• type Source
  • func (s *Source) FirebaseRulesClient() *firebaserules.Service
  • func (s *Source) FirestoreClient() *firestore.Client
  • func (s *Source) GetDatabaseId() string
  • func (s *Source) GetProjectId() string
  • func (s *Source) SourceKind() string

Constants

const SourceKind string = "firestore"

Types

type Config

type Config struct {
	// Firestore configs
	Name     string `yaml:"name" validate:"required"`
	Kind     string `yaml:"kind" validate:"required"`
	Project  string `yaml:"project" validate:"required"`
	Database string `yaml:"database"` // Optional, defaults to "(default)"
}

func (Config) Initialize

func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error)

func (Config) SourceConfigKind

func (r Config) SourceConfigKind() string

type Source

type Source struct {
	// Firestore struct with client
	Name        string `yaml:"name"`
	Kind        string `yaml:"kind"`
	Client      *firestore.Client
	RulesClient *firebaserules.Service
	ProjectId   string `yaml:"projectId"`
	DatabaseId  string `yaml:"databaseId"`
}

func (*Source) FirebaseRulesClient

func (s *Source) FirebaseRulesClient() *firebaserules.Service

func (*Source) FirestoreClient

func (s *Source) FirestoreClient() *firestore.Client

func (*Source) GetDatabaseId

func (s *Source) GetDatabaseId() string

func (*Source) GetProjectId

func (s *Source) GetProjectId() string

func (*Source) SourceKind

func (s *Source) SourceKind() string