bigtable

README

bigtable

Usage

source:
  name: bigtable
  config:
    project_id: google-project-id
    service_account_base64: _________BASE64_ENCODED_SERVICE_ACCOUNT_________________

Inputs

Key	Value	Example	Description	required
project_id	string	my-project	BigTable Project ID	true
service_account_base64	string	BASE64_ENCODED_SERVICE_ACCOUNT	Service Account in base64 encoded string.	optional

Notes

You will have to set the env var GOOGLE_APPLICATION_CREDENTIALS with value as path of the service account json file. if service_account_base64 is not specified.

Outputs

Field	Sample Value
resource.urn	project_id.instance_name.table_name
resource.name	table_name
resource.service	bigtable
attributes.fields	Fields

Fields

Field	Sample Value
column_family	[{\"Name\":\"ts\",\"GCPolicy\":\"(age() \\u003e 90d)\"}]

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Documentation

Index

• func WithAdminClientMW(projectID, instanceName string) func(AdminClient) AdminClient
• func WithInstanceAdminClientMW(projectID string) func(InstanceAdminClient) InstanceAdminClient
• type AdminClient
• type AdminClientMW
  • func (o *AdminClientMW) TableInfo(ctx context.Context, table string) (res *bigtable.TableInfo, err error)
  • func (o *AdminClientMW) Tables(ctx context.Context) (res []string, err error)
• type Config
• type Extractor
  • func New(logger log.Logger, newClient NewClientFunc, newAdminClient NewAdminClientFunc) *Extractor
  • func (e *Extractor) Extract(ctx context.Context, emit plugins.Emit) error
  • func (e *Extractor) Init(ctx context.Context, config plugins.Config) error
• type InstanceAdminClient
• type InstanceAdminClientMW
  • func (o *InstanceAdminClientMW) Instances(ctx context.Context) (res []*bigtable.InstanceInfo, err error)
• type InstancesFetcher
• type NewAdminClientFunc
• type NewClientFunc

Functions

func WithAdminClientMW

func WithAdminClientMW(projectID, instanceName string) func(AdminClient) AdminClient

func WithInstanceAdminClientMW

func WithInstanceAdminClientMW(projectID string) func(InstanceAdminClient) InstanceAdminClient

Types

type AdminClient

type AdminClient interface {
	Tables(ctx context.Context) ([]string, error)
	TableInfo(ctx context.Context, table string) (*bigtable.TableInfo, error)
}

AdminClient is an interface for *bigtable.AdminClient

type AdminClientMW

type AdminClientMW struct {
	// contains filtered or unexported fields
}

func (*AdminClientMW) TableInfo

func (o *AdminClientMW) TableInfo(ctx context.Context, table string) (res *bigtable.TableInfo, err error)

func (*AdminClientMW) Tables

func (o *AdminClientMW) Tables(ctx context.Context) (res []string, err error)

type Config

type Config struct {
	ProjectID            string `json:"project_id" yaml:"project_id" mapstructure:"project_id" validate:"required"`
	ServiceAccountBase64 string `mapstructure:"service_account_base64"`
	// contains filtered or unexported fields
}

Config holds the configurations for the bigtable extractor

type Extractor

type Extractor struct {
	plugins.BaseExtractor
	// contains filtered or unexported fields
}

Extractor used to extract bigtable metadata

func New

func New(logger log.Logger, newClient NewClientFunc, newAdminClient NewAdminClientFunc) *Extractor

func (*Extractor) Extract

func (e *Extractor) Extract(ctx context.Context, emit plugins.Emit) error

Extract checks if the extractor is configured and if so, then extracts the metadata and returns the assets.

func (*Extractor) Init

func (e *Extractor) Init(ctx context.Context, config plugins.Config) error

type InstanceAdminClient

type InstanceAdminClient interface {
	Instances(ctx context.Context) ([]*bigtable.InstanceInfo, error)
}

InstanceAdminClient is an interface for *bigtable.InstanceAdminClient

type InstanceAdminClientMW

type InstanceAdminClientMW struct {
	// contains filtered or unexported fields
}

func (*InstanceAdminClientMW) Instances

func (o *InstanceAdminClientMW) Instances(ctx context.Context) (res []*bigtable.InstanceInfo, err error)

type InstancesFetcher

type InstancesFetcher interface {
	Instances(context.Context) ([]*bigtable.InstanceInfo, error)
}

InstancesFetcher is an interface for fetching instances

type NewAdminClientFunc

type NewAdminClientFunc func(ctx context.Context, instance string, config Config) (AdminClient, error)

type NewClientFunc

type NewClientFunc func(ctx context.Context, cfg Config) (InstanceAdminClient, error)