xk6_couchbase

README

CouchBase k6 extension

K6 extension to perform tests on couchbase.

Currently Supported Commands

• Supports inserting a document.
• Supports Batch insertion.
• Supports findOne (Fetch by primary key)
• Supports deleting a document by id
• Testing query performance
• Prepared statement query performance

Examples:

Document Insertion Test

import xk6_couchbase from 'k6/x/couchbase';


const client = xk6_couchbase.newClient('localhost', '<username>', '<password>');
export default () => {

    let doc = {
        correlationId: `test--couchbase`,
        title: 'Perf test experiment',
        url: 'example.com',
        locale: 'en',
        time: `${new Date(Date.now()).toISOString()}`
    };
    client.insert("test", "_default", "_default", makeId(15), doc);
}

function makeId(length) {
    let result = '';
    const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
    const charactersLength = characters.length;
    let counter = 0;
    while (counter < length) {
        result += characters.charAt(Math.floor(Math.random() * charactersLength));
        counter += 1;
    }
    return result;
}

Batch Insert Documents

import xk6_couchbase from 'k6/x/couchbase';


const client = xk6_couchbase.newClient('localhost', '<username>', '<password>');

const batchsize = 50;

export default () => {

    var docobjs = {}

    for (var i = 0; i < batchsize; i++) {
        docobjs[makeId(15)] = getRecord();
    }

    client.insertBatch("test", "_default", "_default", docobjs);
}

function getRecord() {
    return {
        correlationId: `test--couchbase`,
        title: 'Perf test experiment',
        url: 'example.com',
        locale: 'en',
        time: `${new Date(Date.now()).toISOString()}`
    };


}

function makeId(length) {
    let result = '';
    const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
    const charactersLength = characters.length;
    let counter = 0;
    while (counter < length) {
        result += characters.charAt(Math.floor(Math.random() * charactersLength));
        counter += 1;
    }
    return result;
}

FindOne test

import xk6_couchbase from 'k6/x/couchbase';


const client = xk6_couchbase.newClient('localhost', '<username>', '<password>');
export default () => {
    // syntax :: client.findOne("<db>", "<scope>", "<keyspace>", "<docId>");
    var res = client.findOne("test", "_default", "_default", "002wPJwiJArcUpz");
    console.log(res);
}

Document Deletion Test

import xk6_couchbase from 'k6/x/couchbase';


const client = xk6_couchbase.newClient('localhost', '<username>', '<password>');
export default () => {

    client.remove("test", "_default", "_default", "002wPJwiJArcUpz", doc);
}

Query test

import xk6_couchbase from 'k6/x/couchbase';


const client = xk6_couchbase.newClient('localhost', '<username>', '<password>');
export default () => {
    var res = client.find("select * from test._default._default  use keys \"00096zszpZaT47X\"");

    //console.log(res);

}

Query using a prepared statement

import xk6_couchbase from 'k6/x/couchbase';


const client = xk6_couchbase.newClient('localhost', '<username>', '<password>');
export default () => {
    var res = client.findByPreparedStmt("select * from test._default._default  use keys \"00096zszpZaT47X\"");

    //console.log(res);

}

Documentation

Index

• type Client
  • func (c *Client) Find(query string) (any, error)
  • func (c *Client) FindByPreparedStmt(query string, params ...interface{}) (any, error)
  • func (c *Client) FindOne(bucketName, scope, collection, docId string) (any, error)
  • func (c *Client) Insert(bucketName, scope, collection, docId string, doc any) error
  • func (c *Client) InsertBatch(bucketName, scope, collection string, docs map[string]any) error
  • func (c *Client) Remove(bucketName, scope, collection, docId string) error
• type CouchBase
  • func (*CouchBase) NewClient(connectionString, username, password string) interface{}

Types

type Client

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

func (*Client) Find

func (c *Client) Find(query string) (any, error)

func (*Client) FindByPreparedStmt

func (c *Client) FindByPreparedStmt(query string, params ...interface{}) (any, error)

func (*Client) FindOne

func (c *Client) FindOne(bucketName, scope, collection, docId string) (any, error)

func (*Client) Insert

func (c *Client) Insert(bucketName, scope, collection, docId string, doc any) error

func (*Client) InsertBatch

func (c *Client) InsertBatch(bucketName, scope, collection string, docs map[string]any) error

func (*Client) Remove

func (c *Client) Remove(bucketName, scope, collection, docId string) error

type CouchBase

type CouchBase struct{}

func (*CouchBase) NewClient

func (*CouchBase) NewClient(connectionString, username, password string) interface{}