Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IConnectionMeta

Represents the meta-data information about the connection and connected databases.

Hierarchy

  • IConnectionMeta

Index

Properties

Methods

Properties

connection

connection: IConnection

Returns the Connection object

returns

Methods

getDatabase

  • getDatabase(database: string | number): Promise<IDatabase>

  • Returns a certain database of this connection. If the type of "database" is string, it returns the database with the given name of the connection. If the type of "database" is number, it returns the Nth database of the connection.

    Parameters

    • database: string | number

      The database name or index position (zero base).

    Returns Promise<IDatabase>

getDatabases

  • Returns all the connected databases on the akera.io application server.

    Returns Promise<IDatabase[]>

getNumDatabases

  • getNumDatabases(): Promise<number>

  • Returns the number of connected databases on the akera.io application server.

    Returns Promise<number>

getTable

  • getTable(tableName: string, dbName?: string): Promise<ITable>

  • Returns a table by name by searching through all connected databases or, if the table name is fully qualified (aka it does contains the database name) from that specific database.

    Parameters

    • tableName: string

      The name of the table, it can be fully qualified (database.table).

    • Optional dbName: string

    Returns Promise<ITable>