package
0.10.1
Repository: https://github.com/kubemq-hub/kubemq-targets.git
Documentation: pkg.go.dev

# README

Kubemq GCP-Postgres Target Connector

Kubemq postgres target connector allows services using kubemq server to access postgres database services.

Prerequisites

The following are required to run the postgres target connector:

  • kubemq cluster
  • postgres server
  • kubemq-targets deployment

Configuration

Postgres target connector configuration properties:

Properties KeyRequiredDescriptionExample
max_idle_connectionsnoset max idle connections"10"
max_open_connectionsnoset max open connections"100"
connection_max_lifetime_secondsnoset max lifetime for connections in seconds"3600"
credentialsyesgcp credentials files"google json credentials"
instance_connection_nameyesset sql instance nameproject:us-east1:db-porudction
db_useryesgcp db user name files"google user"
db_nameyesgcp db name"google instance name"
db_passwordyesgcp db password"google db password"

Example:

bindings:
  - name: kubemq-query-gcp-postgres
    source:
      kind: kubemq.query
      name: kubemq-query
      properties:
        address: "kubemq-cluster:50000"
        client_id: "kubemq-query-gcp-postgres-connector"
        auth_token: ""
        channel: "query.postgres"
        group:   ""
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind: gcp.stores.postgres
      name: target-gcp-postgres
      properties:
        instance_connection_name: "instanceConnectionName"
        db_user:                  "user"
        db_name:                  "dbName"
        db_password:              "dbPassword"
        max_idle_connections: "10"
        max_open_connections: "100"
        connection_max_lifetime_seconds: "3600"
        credentials: 'json'

Usage

Query Request

Query request metadata setting:

Metadata KeyRequiredDescriptionPossible values
methodyesset type of request"query"

Query request data setting:

Data KeyRequiredDescriptionPossible values
datayesquery stringbase64 bytes array

Example:

Query string: SELECT id,title,content FROM post;

{
  "metadata": {
    "method": "query"
  },
  "data": "U0VMRUNUIGlkLHRpdGxlLGNvbnRlbnQgRlJPTSBwb3N0Ow=="
}

Exec Request

Exec request metadata setting:

Metadata KeyRequiredDescriptionPossible values
methodyesset type of request"exec"
isolation_levelnoset isolation level for exec operation""
"read_uncommitted"
"read_committed"
"repeatable_read"
"serializable"

Exec request data setting:

Data KeyRequiredDescriptionPossible values
datayesexec stringbase64 bytes array

Example:

Exec string:

INSERT INTO post(ID,TITLE,CONTENT) VALUES (1,NULL,'Content One'),(2,'Title Two','Content Two');
{
  "metadata": {
    "method": "exec",
    "isolation_level": "read_uncommitted"
  },
  "data": "SU5TRVJUIElOVE8gcG9zdChJRCxUSVRMRSxDT05URU5UKSBWQUxVRVMKCSAgICAgICAgICAgICAgICAgICAgICAgKDEsTlVMTCwnQ29udGVudCBPbmUnKSwKCSAgICAgICAgICAgICAgICAgICAgICAgKDIsJ1RpdGxlIFR3bycsJ0NvbnRlbnQgVHdvJyk7" 
}

Transaction Request

Transaction request metadata setting:

Metadata KeyRequiredDescriptionPossible values
methodyesset type of request"transaction"
isolation_levelnoset isolation level for exec operation""
"read_uncommitted"
"read_committed"
"repeatable_read"
"serializable"

Transaction request data setting:

Data KeyRequiredDescriptionPossible values
datayesstring stringbase64 bytes array

Example:

Transaction string:

DROP TABLE IF EXISTS post;
CREATE TABLE post (
         ID serial,
         TITLE varchar(40),
         CONTENT varchar(255),
         CONSTRAINT pk_post PRIMARY KEY(ID)
       );
INSERT INTO post(ID,TITLE,CONTENT) VALUES
                       (1,NULL,'Content One'),
                       (2,'Title Two','Content Two');
{
  "metadata": {
    "method": "transaction"
  },
  "data": "CURST1AgVEFCTEUgSUYgRVhJU1RTIHBvc3Q7CiAgICBDUkVBVEUgVEFCTEUgcG9zdCAoCgkgICAgICAgICBJRCBzZXJpYWwsCgkgICAgICAgICBUSVRMRSB2YXJjaGFyKDQwKSwKCSAgICAgICAgIENPTlRFTlQgdmFyY2hhcigyNTUpLAoJICAgICAgICAgQ09OU1RSQUlOVCBwa19wb3N0IFBSSU1BUlkgS0VZKElEKQoJICAgICAgICk7CiAgICBJTlNFUlQgSU5UTyBwb3N0KElELFRJVExFLENPTlRFTlQpIFZBTFVFUwoJICAgICAgICAgICAgICAgICAgICAgICAoMSxOVUxMLCdDb250ZW50IE9uZScpLAoJICAgICAgICAgICAgICAgICAgICAgICAoMiwnVGl0bGUgVHdvJywnQ29udGVudCBUd28nKTs="
}

# Functions

No description provided by the author
No description provided by the author

# Structs

Client is a Client state store.