Initializes the connector for use. This is similar to connect(), but stops short of actually connecting to the server.

Create a connection to the MapD server, generating a client and session ID.

Connect to a MapD server:

var con = new DbCon()
  .host('localhost')
  .port('8080')
  .dbName('myDatabase')
  .user('foo')
  .password('bar')
  .connect()
  .then((con) => console.log(con.sessionId()));

  // ["om9E9Ujgbhl6wIzWgLENncjWsaXRDYLy"]

Create a connection to the MapD server, generating a client and session ID.

Connect to a MapD server:

var con = new DbCon()
  .host('localhost')
  .port('8080')
  .dbName('myDatabase')
  .user('foo')
  .password('bar')
  .connect((err, con) => console.log(con.sessionId()));

  // ["om9E9Ujgbhl6wIzWgLENncjWsaXRDYLy"]

Disconnect from the server and then clear the client and session values.

Disconnect from the server:

con.disconnect()

Disconnect from the server and then clear the client and session values.

Disconnect from the server:

con.sessionId() // ["om9E9Ujgbhl6wIzWgLENncjWsaXRDYLy"]
con.disconnect((err, con) => console.log(err, con))
con.sessionId() === null;

Get the status of the server as a TServerStatus object. This includes the server version number, whether the server is read-only, and whether backend rendering is enabled.

Get the server status:

con.getStatusAsync().then((result) => console.log(result))
// [{
//   "read_only": false,
//   "version": "3.0.0dev-20170503-40e2de3",
//   "rendering_enabled": true,
//   "start_time": 1493840131
// }]

Get the status of the server as a TServerStatus object. This includes the server version number, whether the server is read-only, and whether backend rendering is enabled.

Get the server status:

con.getStatus((err, result) => console.log(result))
// [{
//   "read_only": false,
//   "version": "3.0.0dev-20170503-40e2de3",
//   "rendering_enabled": true,
//   "start_time": 1493840131
// }]

Get information about the server hardware:

• Number of GPUs.
• Number of GPUs allocated to MapD.
• Start GPU.
• Number of SMs, SMXs, or CUs (streaming multiprocessors).
• Clock frequency of each GPU.
• Physical memory of each GPU.
• Compute capability of each GPU.

Get server hardware information:

con.getHardwareInfoAsync().then((result) => console.log(result))
{
  "hardware_info": [{
   "num_gpu_hw": 2,
     "num_cpu_hw": 12,
     "num_gpu_allocated": 2,
     "start_gpu": 0,
     "host_name": "",
     "gpu_info": [{
         "num_sm": 28,
         "clock_frequency_kHz": 1531000,
         "memory": 12781682688,
         "compute_capability_major": 6,
         "compute_capability_minor": 1
     }, {
         "num_sm": 28,
         "clock_frequency_kHz": 1531000,
         "memory": 12782075904,
         "compute_capability_major": 6,
         "compute_capability_minor": 1
     }]
  }]
}

Get information about the server hardware:

• Number of GPUs.
• Number of GPUs allocated to MapD.
• Start GPU.
• Number of SMs, SMXs, or CUs (streaming multiprocessors).
• Clock frequency of each GPU.
• Physical memory of each GPU.
• Compute capability of each GPU.

Get server hardware information:

con.getHardwareInfo((err, result) => console.log(result))
{
  "hardware_info": [{
   "num_gpu_hw": 2,
     "num_cpu_hw": 12,
     "num_gpu_allocated": 2,
     "start_gpu": 0,
     "host_name": "",
     "gpu_info": [{
         "num_sm": 28,
         "clock_frequency_kHz": 1531000,
         "memory": 12781682688,
         "compute_capability_major": 6,
         "compute_capability_minor": 1
     }, {
         "num_sm": 28,
         "clock_frequency_kHz": 1531000,
         "memory": 12782075904,
         "compute_capability_major": 6,
         "compute_capability_minor": 1
     }]
  }]
}

Get the first geo file in an archive, if present, to determine if the archive should be treated as geo.

Get the first geo file in an archive:

con.getFirstGeoFileInArchiveAsync('archive.zip', {}).then(res => console.log(res))

Gets a list of filenames found within an archive.

Get the filenames found within an archive:

con.getFilesInArchiveAsync('archive.zip', {}).then(res => console.log(res))

Get a list of all users on the database for this connection.

Get a list of all users:

con.getUsersAsync().then(res => console.log(res))

Get a list of all roles on the database for this connection.

Get a list of all roles:

con.getRolesAsync().then(res => console.log(res))

Get a list of all dashboards on the database for this connection.

Get a list of all dashboards:

con.getDashboardsAsync().then(res => console.log(res))

Get a single dashboard.

Get a dashboard:

con.getDashboardAsync().then(res => console.log(res))

Add a new dashboard to the server.

Add a new dashboard to the server:

con.createDashboardAsync('newSave', 'dashboardstateBase64', null, 'metaData').then(res => console.log(res))

Replace a dashboard on the server with new properties.

Replace a dashboard on the server:

con.replaceDashboardAsync(123, 'replaceSave', 'owner', 'dashboardstateBase64', null, 'metaData').then(res => console.log(res))

Delete a dashboard object containing a value for the view_state property.

Delete a specific dashboard from the server:

con.deleteDashboardAsync(123).then(res => console.log(res))

Delete multiple dashboards

Delete dashboards from the server:

con.deleteDashboardsAsync([123, 456]).then(res => console.log(res))

Share a dashboard (GRANT a certain set of permissions to a specified list of groups).

Share a dashboard:

con.shareDashboardAsync(123, ['group1', 'group2'], ['object1', 'object2'], ['perm1', 'perm2']).then(res => console.log(res))

Share multiple dashboards.

Share dashboards:

con.shareDashboardsAsync([123, 456], ['group1', 'group2'], ['perm1', 'perm2']).then(res => console.log(res))

Stop sharing a dashboard (REVOKE a certain set of permission from a specified list of groups).

Unshare a dashboard:

con.unshareDashboardAsync(123, ['group1', 'group2'], ['object1', 'object2'], ['perm1', 'perm2']).then(res => console.log(res))

Unshare multiple dashboards.

Unshare dashboards:

con.unshareDashboardsAsync([123, 456], ['group1', 'group2'], ['perm1', 'perm2']).then(res => console.log(res))

Get the list of users that a dashboard has been shared with; that is, those users who have been granted permissions to the dashboard.

Get the list of grantees for a dashboard:

con.getDashboardGranteesAsync(123).then(res => console.log(res))

Get a list of database objects granted to a role; that is, those objects the role has permissions to access.

Get list of accessible database objects for a role:

con.getDbObjectsForGranteeAsync('role').then(res => console.log(res))

Get the privileges for the current user for a specified database object type and ID.

Get the list of accessible database objects for the current user:

con.getDbObjectPrivsAsync('table_name', 'TableDBObjectType').then(res => console.log(res))

Get all the roles assigned directly to a given username.

Get all the roles assigned to a given username recursively (ie, roles assigned to the user, and roles assigned to those roles, and so on).

Checks if the given user or role has a privilege(s) on a given object. Note that this check is transative; if a user has been granted a privilege via a role, this will return true.

Check if user my_user has the "view SQL Editor" privilege on the my_db database:

con.hasDbPrivilegesAsync(
  "my_user",
  "my_db",
  TDBObjectType.DatabaseDBObjectType,
  new TDBObjectPermissions({
    database_permissions_: new TDatabasePermissions(dbPrivs)
  })
).then((res) =>
  if(res) { console.log("Can view the SQL editor") }
)

Specialization of has_object_privilege for checking database privileges of a user.

Check if user my_user has the "view SQL Editor" privilege on the my_db database:

con.hasDbPrivilegesAsync("my_user", "my_db", {view_sql_editor_: true}).then(res =>
 if(res) { console.log("Can view the SQL editor") }
)

Asynchronously get data from an importable file, such as a CSV or plaintext file with a header.

Get data from table_data.csv:

var copyParams = new TCopyParams();
con.detectColumnTypesAsync('table_data.csv', copyParams).then(res => console.log(res))
// TDetectResult {row_set: TRowSet, copy_params: TCopyParams}

Submit a query to the database and process the results.

Create a query:

var query = "SELECT count(*) AS n FROM tweets_nov_feb WHERE country='CO'";
var options = {};

con.query(query, options).then((result) => console.log(result));

Submit a query to the database and process the results.

Create a query:

var query = "SELECT count(*) AS n FROM tweets_nov_feb WHERE country='CO'";
var options = {};

con.query(query, options, function(err, result) {
       console.log(result)
     });

Submit a query to validate that the backend can create a result set based on the SQL statement.

Create a query and determine if it is valid:

var query = "SELECT count(*) AS n FROM tweets_nov_feb WHERE country='CO'";

con.validateQuery(query).then(res => console.log(res))

// [{
//    "name": "n",
//    "type": "INT",
//    "is_array": false,
//    "is_dict": false
//  }]

Get the names of the databases that exist in the current session connection.

Get the list of tables from a connection:

con.getTablesAsync().then(res => console.log(res))

 //  [{
 //    label: 'obs', // deprecated property
 //    name: 'myTableName'
 //   },
 //  ...]

Get the names of the databases that exist in the current session connection.

Get the list of tables from a connection:

con.getTablesAsync((err, res) => console.log(res))

 //  [{
 //    label: 'obs', // deprecated property
 //    name: 'myTableName'
 //   },
 //  ...]

Get names and catalog metadata for tables that exist on the current session's connection.

Get the list of tables with metadata from a connection:

con.getTablesWithMetaAsync().then(res => console.log(res))

 [
  {
   name: 'my_table_name',
   col_datum_types: [TDatumType::BOOL, TDatumType::DOUBLE],
   is_view: false,
   is_replicated: false,
   shard_count: 0,
   max_rows: -1
  },
 ...]

Get names and catalog metadata for tables that exist on the current session's connection.

Get the list of tables with metadata from a connection:

con.getTablesMetaAsync().then(res => console.log(res))

 [
  {
   table_name: 'my_table_name',
   col_datum_types: [TDatumType::BOOL, TDatumType::DOUBLE],
   col_names: ['bool_col', 'double_col'],
   is_view: false,
   is_replicated: false,
   shard_count: 0,
   max_rows: -1
  },
 ...]

Returns a list of available table function names

Returns a list of available runtime table function names

Submits an SQL string to the backend and returns a completion hints object.

const queryString = "f";
const cursor = 1;

con.getCompletionHints(queryString, cursor, function(error, result) {
       console.log(result)
     });

 [{
   hints: ["FROM"],
   replaced: "f",
   type: 7
  }]

Submits an SQL string to the backend and returns a completion hints object.

const queryString = "f";
const cursor = 1;

con.getCompletionHints(queryString, cursor, function(error, result) {
       console.log(result)
     });

 [{
   hints: ["FROM"],
   replaced: "f",
   type: 7
  }]

Create an array-like object from TDatumType by changing the order of the string key and numerical value.

Get a list of field objects for a specified table.

Get the list of fields from a specific table:

con.getFields('flights', (err, res) => console.log(res))
// [{
  name: 'fieldName',
  type: 'BIGINT',
  is_array: false,
  is_dict: false
}, ...]

Get a list of field objects for a specified table.

Get the list of fields from a specific table:

con.getFields('flights', (err, res) => console.log(res))
// [{
  name: 'fieldName',
  type: 'BIGINT',
  is_array: false,
  is_dict: false
}, ...]

Create a table and persist it to the backend.

Create a new table:

con.createTable('mynewtable', [TColumnType, TColumnType, ...], 0).then(res => console.log(res));
 // undefined

Import a delimited table from a file.

Import a geo table from a file.

Use for backend rendering. This method fetches a PNG image that is a render of the Vega JSON object. The Image will be a string if using browser-connector.js, or a Buffer otherwise.

Use for backend rendering. This method fetches a PNG image that is a render of the Vega JSON object. The Image will be a string if using browser-connector.js, or a Buffer otherwise.

Used primarily for backend-rendered maps; fetches the row for a specific table that was last rendered at a pixel.

Used primarily for backend-rendered maps; fetches the row for a specific table that was last rendered at a pixel.

Get or set the session ID used by the server to serve the correct data. This is typically set by connect and should not be set manually.

Get the session ID:

con.sessionId();
// sessionID === 3145846410

Set the session ID:

var con = new DbCon().connect().sessionId(3415846410);
// NOTE: It is generally unsafe to set the session ID manually.

Get or set the connection server hostname. This is is typically the first method called after instantiating a new DbCon.

Set the hostname:

var con = new DbCon().host('localhost');

Get the hostname:

var host = con.host();
// host === 'localhost'

Get or set the connection port.

Set the port:

var con = new DbCon().port('8080');

Get the port:

var port = con.port();
// port === '8080'

Get or set the username with which to authenticate.

Set the username:

var con = new DbCon().user('foo');

Get the username:

var username = con.user();
// user === 'foo'

Get or set the user password for authentication.

Set the password:

var con = new DbCon().password('bar');

Get the username:

var password = con.password();
// password === 'bar'

Get or set the name of the database to connect to.

Set the database name:

var con = new DbCon().dbName('myDatabase');

Get the database name:

var dbName = con.dbName();
// dbName === 'myDatabase'

Configure whether raw query strings are logged to the console. Used primarily for debugging; false by default.

Set logging to true:

var con = new DbCon().logging(true);

Get the logging flag:

var isLogging = con.logging();
// isLogging === true

The name of the platform.

Set the platform name:

var con = new DbCon().platform('myPlatform');

Get the platform name:

var platform = con.platform();
// platform === 'myPlatform'

Get the number of connections that are currently open.

Get the number of connections:

var numConnections = con.numConnections();
// numConnections === 1

The protocol to use for requests.

Set the protocol:

var con = new DbCon().protocol('http');

Get the protocol:

var protocol = con.protocol();
// protocol === 'http'

Disables logic that automatically tries to reconnect to the server if there's an error

Generates a list of endpoints from the connection parameters.

Get the endpoints:

var con = new DbCon().protocol('http').host('localhost').port('8000');
var endpoints = con.getEndpoints();
// endpoints === [ 'http://localhost:8000' ]

Set the license for Trial or Enterprise

Get the license for Trial or Enterprise

Converts a raw integer timestamp value from the DB into milliseconds. The DB timestamp value may represent seconds, ms, us, or ns depending on the precision of the column. This value is truncated or extended as necessary to convert to ms precision. The returned ms value is suitable for passing to the JS Date object constructor.

Converts a Number/BigInt value to a Boolean

Process the column-based results from the query in a row-based format. (Returning row-based results directly from the server is inefficient.)

Determines how to process raw results when they return from the server.

Query for row-based results from the server. In general, is inefficient and should be avoided. Instead, use processColumnarResults and then convert the results to row-based format.

<caption> Return row-based results directly from the server:

The information about a particular field in a given table.

Type: TTypeInfo

The types of the completion hint response object.

Type: completion_hints

The types of tables that uploaded through the importer TTableType.

Type: TTableType

Contains the result from calling detectColumnTypes.

Type: TDetectResult

The data stored for a dashboard.

Type: TFrontendView

The valid types for database field values.

Type: Object

Import completion status of a table.

Type: TImportStatus

The value of an individual cell in a table.

Type: TDatumVal

The value and state of an individual data cell in a table.

Type: TDatum

A row of data in a table.

Type: TRow

Type: TColumnType

Contains parsed table data.

Type: TRowSet

The permissions granted by the server.

Type: TServerStatus

The configuration required to import a table into MapD. See detectColumnTypes for a usage example.

Type: TCopyParams