API Concepts

Unsecured Connections

• C++
• C#
• Java
• JavaScript
• Node.js
• Python
• REST

1
2
3
4
5
6
7

#include "gpudb/GPUdb.hpp"

gpudb::GPUdb::Options options = gpudb::GPUdb::Options();
options.setUsername("<username>");
options.setPassword("<password>");

gpudb::GPUdb kdb("http://<host.name>:9191", options);

1
2
3
4
5
6
7

using kinetica;

Kinetica.Options options = new Kinetica.Options();
options.Username = "<username>";
options.Password = "<password>";

Kinetica kdb = new Kinetica("http://<host.name>:9191", options );

1
2
3
4
5
6
7

import com.gpudb.GPUdb;

GPUdb.Options options = new GPUdb.Options()
    .setUsername("<username>")
    .setPassword("<password>");

GPUdb kdb = new GPUdb("http://<host.name>:9191", options);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

<script type="text/javascript" src="GPUdb.js"></script>
<script type="text/javascript">
var kdb = new GPUdb(
    "http://<host.name>:9191",
    {
        username: "<username>",
        password: "<password>"
    }
);
</script>

1
2
3
4
5
6
7
8
9

// To install Kinetica, first run this from the CLI: npm i @kinetica/gpudb
var GPUdb = require("@kinetica/gpudb");
var kdb = new GPUdb(
    ["http://<host.name>:9191"],
    {
        username: "<username>",
        password: "<password>"
    }
);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

import gpudb

options = gpudb.GPUdb.Options()
options.username = "<username>"
options.password = "<password>"

kdb = gpudb.GPUdb(
    host=["http://<host.name>:9191"],
    options = options
)

1
2
3
4

curl --user <username>:<password> --location --request POST \
    'http://<host.name>:9191' \
    --header 'cache-control: no-cache' \
    --header 'content-type: application/json'

Secured Connections

• C++
• C#
• Java
• JavaScript
• Node.js
• Python
• REST

1
2
3
4
5
6
7

#include "gpudb/GPUdb.hpp"

gpudb::GPUdb::Options options = gpudb::GPUdb::Options();
options.setUsername("<username>");
options.setPassword("<password>");

gpudb::GPUdb kdb("https://<host.name>:8082/gpudb-0", options);

1
2
3
4
5
6
7

using kinetica;

Kinetica.Options options = new Kinetica.Options();
options.Username = "<username>";
options.Password = "<password>";

Kinetica kdb = new Kinetica("https://<host.name>:8082/gpudb-0", options );

1
2
3
4
5
6
7

import com.gpudb.GPUdb;

GPUdb.Options options = new GPUdb.Options()
    .setUsername("<username>")
    .setPassword("<password>");

GPUdb kdb = new GPUdb("https://<host.name>:8082/gpudb-0", options);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

<script type="text/javascript" src="GPUdb.js"></script>
<script type="text/javascript">
var kdb = new GPUdb(
    "https://<host.name>:8082/gpudb-0",
    {
        username: "<username>",
        password: "<password>"
    }
);
</script>

1
2
3
4
5
6
7
8
9

// To install Kinetica, first run this from the CLI: npm i @kinetica/gpudb
var GPUdb = require("@kinetica/gpudb");
var kdb = new GPUdb(
    ["https://<host.name>:8082/gpudb-0"],
    {
        username: "<username>",
        password: "<password>"
    }
);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

import gpudb

options = gpudb.GPUdb.Options()
options.username = "<username>"
options.password = "<password>"

kdb = gpudb.GPUdb(
    host=["https://<host.name>:8082/gpudb-0"],
    options = options
)

1
2
3
4

curl --user <username>:<password> --location --request POST \
    'https://<host.name>:8082/gpudb-0' \
    --header 'cache-control: no-cache' \
    --header 'content-type: application/json'

Dynamic Schemas in Python

As an example, using Python, consider doing an aggregate_groupby on a string column named dept_name, computing the max of a integer column named sal:

retobj = gpudb.aggregate_group_by(
             table_name = 'emp',
             column_names = ['dept_name','max(sal)'],
             offset = 0,
             limit = 10,
             encoding = 'json',
             options = {'sort_by':'key'}
         )

In this case, retobj['response_schema_str'] will look like:

{
    "fields": [
        {
            "name": "column_1",
            "type": {
                "items": "string",
                "type": "array"
            }
        },
        {
            "name": "column_2",
            "type": {
                "items": [
                    "int",
                    "null"
                ],
                "type": "array"
            }
        },
        {
            "name": "column_headers",
            "type": {
                "items": "string",
                "type": "array"
            }
        },
        {
            "name": "column_datatypes",
            "type": {
                "items": "string",
                "type": "array"
            }
        }
    ],
    "name": "generic_response",
    "type": "record"
}

And the actual data response, retobj['json_encoded_response'], will look like:

{
    "column_1": [
        "DEPT1",
        "DEPT2",
        "DEPT3",
        "DEPT4"
    ],
    "column_2": [
        200000,
        150000,
        110000,
        12345
    ],
    "column_datatypes": [
        "char64",
        "int"
    ],
    "column_headers": [
        "dept_name",
        "max(sal)"
    ]
}

The enumerated columns can be translated into their textual names using the gpudb.parse_dynamic_response(retobj)['response'] function, resulting in this:

OrderedDict
(
    [
        (u'dept_name', [u'DEPT1', u'DEPT2', u'DEPT3', u'DEPT4']),
        (u'max(sal)', [200000, 150000, 110000, 12345])
    ]
)

Dynamic Schemas in Java

Dynamic schemas are simpler to handle in Java. The Record, Type, and Column classes take care of the lower level details and provide a simple way to access the data. Once the records are returned by your query, you can get the type of the record and all the column details from the type. Below is an example of a query, iterating through the records, and iterating through each column in each record.:

AggregateGroupByResponse resp1 = gpudb.aggregateGroupBy(aggGroupByRequest);
List<Record> records = resp1.getData();
for(Record rec : records){
    Type type = rec.getType();

    List<Type.Column> columns = type.getColumns();
    for(int i=0;i<columns.size();i++){
        System.out.printf("%s:%s, ", columns.get(i).getName() ,rec.get(i));
    }
    System.out.println();
}