dbGetInfo: dbGetInfo()

Description Usage Arguments Value See Also Examples

Description

Generic dbGetInfo() implementation.

Retrieves brief KineticaDriver description: dbname, driver version, client version, max number of connections (NA stands for unlimited)

Basic properties of KineticaConnection object provides DB version, primary url, host, port and username of the current connection, flag for HA availability, HA ring of secondary urls and maximum row count that can be returned in one query

Provides basic info on KineticaResult object

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
dbGetInfo(dbObj, ...)

## S4 method for signature 'KineticaDriver'
dbGetInfo(dbObj, ...)

## S4 method for signature 'KineticaConnection'
dbGetInfo(dbObj, ...)

## S4 method for signature 'KineticaResult'
dbGetInfo(dbObj, ...)

Arguments

dbObj

An object inheriting from [KineticaObject-class]

...

Other arguments to methods.

dbObj

an object derived of [KineticaDriver-class] type

...

Other arguments omitted in generic signature

dbObj

object [KineticaConnection-class]

...

Other arguments omitted in generic signature

dbObj

[KineticaResult-class]

...

Other parameters passed on to methods.

Value

a named list

See Also

Other KineticaDriver methods: dbCanConnect,KineticaDriver-method, dbConnect,KineticaDriver-method, dbDataType,KineticaDriver-method, dbIsValid, dbListConnections,KineticaDriver-method, dbUnloadDriver,KineticaDriver-method, show,KineticaDriver-method

Other KineticaConnection methods: dbAppendTable, dbCreateTable, dbDataType,KineticaConnection-method, dbDisconnect,KineticaConnection-method, dbExecute,KineticaConnection,character-method, dbExistsTable, dbGetQuery,KineticaConnection,character-method, dbIsValid, dbListFields, dbListObjects,KineticaConnection-method, dbListResults,KineticaConnection-method, dbListTables,KineticaConnection-method, dbReadTable, dbRemoveTable, dbSendQuery,KineticaConnection,character-method, dbSendStatement,KineticaConnection,character-method, dbWriteTable, show,KineticaDriver-method, sqlCreateTable,KineticaConnection-method, transactions

Other KineticaResult methods: dbBind,KineticaResult-method, dbClearResult,KineticaResult-method, dbColumnInfo, dbFetch, dbGetRowCount,KineticaResult-method, dbGetRowsAffected,KineticaResult-method, dbGetStatement,KineticaResult-method, dbHasCompleted,KineticaResult-method, dbIsValid, show,KineticaDriver-method

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
drv <- Kinetica()
dbGetInfo(drv)
# name
#  "KineticaDriver"
# dbname
#  "Kinetica"
# driver.version
#  "7.1.0.0"
# client.version
#  "7.1.0.0"
# max.connections
#  NA

## Not run: 
con <- dbConnect(d, url = "http://localhost:9191")
# db.version
# "7.1.0.0"
# dbname
# "Kinetica"
# url
# "http://localhost:9191"
# host
# "localhost"
# port
# 9191
# username
# ""

## End(Not run)

kineticadb/RKinetica documentation built on Sept. 29, 2020, 5:38 p.m.