plugin

Documentation

Index

• Variables
• func Configure(_ context.Context, logger zerolog.Logger, spec []byte, ...) (plugin.Client, error)
• func Plugin() *plugin.Plugin
• func TestConnection(ctx context.Context, _ zerolog.Logger, specBytes []byte) error
• type Client
  • func (*Client) Close(_ context.Context) error
  • func (c *Client) Logger() *zerolog.Logger
  • func (c *Client) OnBeforeSend(_ context.Context, msg message.SyncMessage) (message.SyncMessage, error)
  • func (c *Client) OnSyncFinish(_ context.Context) error
  • func (c *Client) Sync(ctx context.Context, options plugin.SyncOptions, ...) error
  • func (c *Client) Tables(_ context.Context, options plugin.TableOptions) (schema.Tables, error)

Variables

var (
	Name    = "test"
	Kind    = "source"
	Team    = "cloudquery"
	Version = "development"
)

Functions

func Configure

func Configure(_ context.Context, logger zerolog.Logger, spec []byte, opts plugin.NewClientOptions) (plugin.Client, error)

func Plugin

func Plugin() *plugin.Plugin

func TestConnection

func TestConnection(ctx context.Context, _ zerolog.Logger, specBytes []byte) error

Types

type Client

type Client struct {
	plugin.UnimplementedDestination
	// contains filtered or unexported fields
}

func (*Client) Close

func (*Client) Close(_ context.Context) error

func (*Client) Logger

func (c *Client) Logger() *zerolog.Logger

func (*Client) OnBeforeSend

func (c *Client) OnBeforeSend(_ context.Context, msg message.SyncMessage) (message.SyncMessage, error)

OnBeforeSend increases the usage count for every message. If some messages should not be counted, they can be ignored here.

func (*Client) OnSyncFinish

func (c *Client) OnSyncFinish(_ context.Context) error

OnSyncFinish is used to ensure the final usage count gets reported

func (*Client) Sync

func (c *Client) Sync(ctx context.Context, options plugin.SyncOptions, res chan<- message.SyncMessage) error

func (*Client) Tables

func (c *Client) Tables(_ context.Context, options plugin.TableOptions) (schema.Tables, error)