bigtable

README

Kubemq bigtable target Connector

Kubemq gcp-bigtable target connector allows services using kubemq server to access google bigtable server.

Prerequisites

The following required to run the gcp-bigtable target connector:

• kubemq cluster
• gcp-bigtable set up
• kubemq-targets deployment

Configuration

bigtable target connector configuration properties:

Properties Key	Required	Description	Example
project_id	yes	gcp bigtable project_id	"/myproject"
credentials	yes	gcp credentials files	"<google json credentials"
instance	yes	bigtable instance name	"<bigtable instance name"

Example:

bindings:
  - name: kubemq-query-gcp-bigtable
    source:
      kind: kubemq.query
      name: kubemq-query
      properties:
        address: "kubemq-cluster:50000"
        client_id: "kubemq-query-gcp-bigtable-connector"
        auth_token: ""
        channel: "query.gcp.bigtable"
        group:   ""
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind: gcp.bigtable
      name: gcp-bigtable
      properties:
        project_id: "id"
        credentials: 'json'
        instance:  "instance"

Usage

Create Column Family

Create Column Family:

Metadata Key	Required	Description	Possible values
method	yes	type of method	"create_column_family"
column_family	yes	the column_family to create	"valid unique string"
table_name	yes	the table name	"table name to assign the column family"

Example:

{
  "metadata": {
    "method": "create_column_family",
    "column_family": "valid_unique_string",
    "table_name": "valid_table_string"
  },
  "data": null
}

Create Table

Create a table:

Metadata Key	Required	Description	Possible values
method	yes	type of method	"create_table"
table_name	yes	the table name	"table name to delete or create"

Example:

{
  "metadata": {
    "method": "create_table",
    "table_name": "valid_table_string"
  },
  "data": null
}

Delete Table

Delete the table:

Metadata Key	Required	Description	Possible values
method	yes	type of method	"delete_table"
table_name	yes	the table name	"table name to delete or create"

Example:

{
  "metadata": {
    "method": "delete_table",
    "table_name": "valid_table_string"
  },
  "data": null
}

Write Rows

Write new rows to table by column family

Metadata Key	Required	Description	Possible values
method	yes	type of method	"write"
table_name	yes	the table name	"table name to delete or create"
column_family	yes	the column_family to create	"valid unique string"

Example:

{
  "metadata": {
    "method": "write",
    "column_family": "valid_unique_string",
    "table_name": "valid_table_string"
  },
  "data": "eyJpZCI6MSwibmFtZSI6InRlc3QxIiwic2V0X3Jvd19rZXkiOiIxIn0="
}

Delete Rows

Delete rows from table by prefix

Metadata Key	Required	Description	Possible values
method	yes	type of method	"delete_row"
table_name	yes	the table name	"table name to delete or create"
row_key_prefix	yes	the row key	"valid unique string"

Example:

{
  "metadata": {
    "method": "delete_row",
    "row_key_prefix": "valid unique string",
    "table_name": "valid_table_string"
  },
  "data": null
}

Get All Rows

Get all rows from the table:

Metadata Key	Required	Description	Possible values
method	yes	type of method	"get_all_rows"
table_name	yes	the table name	"table name to delete or create"
row_key_prefix	no	the row key	"valid unique string"
column_name	no	the column to return	"column name"

Example:

{
  "metadata": {
    "method": "get_all_rows",
    "table_name": "valid_table_string"
  },
  "data": null
}

Documentation

Index

• func Connector() *common.Connector
• type Client
  • func New() *Client
  • func (c *Client) Connector() *common.Connector
  • func (c *Client) Do(ctx context.Context, req *types.Request) (*types.Response, error)
  • func (c *Client) Init(ctx context.Context, cfg config.Spec, log *logger.Logger) error
  • func (c *Client) Stop() error

Functions

func Connector

func Connector() *common.Connector

Types

type Client

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

func New

func New() *Client

func (*Client) Connector

func (c *Client) Connector() *common.Connector

func (*Client) Do

func (c *Client) Do(ctx context.Context, req *types.Request) (*types.Response, error)

func (*Client) Init

func (c *Client) Init(ctx context.Context, cfg config.Spec, log *logger.Logger) error

func (*Client) Stop

func (c *Client) Stop() error