Class JdbcApiService

Static Readonly NAME

Static Readonly TYPE

connect

• connect(driverName, uri, userName, password): Promise<Number>

• Connects to a JDBC session.

  Parameters

  • driverName: string

    the JDBC driver name

  • uri: string

    the JDBC URI

  • userName: string

    the user name

  • password: string

    the password

  Returns Promise<Number>

  a promise that resolves to the session ID

disconnect

• disconnect(sessionId): Promise<void>

• Disconnects a JDBC session.

  Parameters

  • sessionId: number

    the session ID

  Returns Promise<void>

  a promise that resolves on successful disconnect

generateSchema

• generateSchema(sessionId, catalog, query, namespace, tableName, assessmentMethod): Promise<string>

• Generates a schema from a jdbc query.

  Parameters

  • sessionId: number

    the session id

  • catalog: string

    the catalog

  • query: string

    the jdbc query

  • namespace: string

    the schema namespace

  • tableName: string

    the schema table name

  • assessmentMethod: string

    the assessment method for type inference

  Returns Promise<string>

  a promise that resolves to a schema xml string

getCatalogNamesTable

• getCatalogNamesTable(sessionId): Promise<Table>

• Gets the catalog names as a Table for a session.

  Parameters

  • sessionId: number

    the session id

  Returns Promise<Table>

  a promise that resolves to a Table

getTableNamesTable

• getTableNamesTable(sessionId, catalogName): Promise<Table>

• Gets the table names as a Table for a session and catalog name.

  Parameters

  • sessionId: number

    the session id

  • catalogName: string

    the catalog name

  Returns Promise<Table>

  a promise that resolves to a Table

jdbcImportSourcePreview

• jdbcImportSourcePreview(sessionId, catalog, query, schemaXml, importSourceName, partitionFormula, intradayPartitionColumn, strict, partitionSubstitution, substitutionDateFormat): Promise<Table>

• Get a preview table for a JDBC import source.

  Parameters

  • sessionId: number

    the session id

  • catalog: string

    the catalog

  • query: string

    the jdbc query

  • schemaXml: string

    the schema as an xml string

  • importSourceName: string

    the import source name

  • partitionFormula: string

    the partition formula

  • intradayPartitionColumn: string

    the intraday partition column

  • strict: boolean

    if the parser should use strict mode

  • partitionSubstitution: string

    the partition substitution

  • substitutionDateFormat: string

  Returns Promise<Table>

  a preview table for the query

queryTable

• queryTable(sessionId, catalog, query, maxRows): Promise<Table>

• Gets a preview table for a jdbc query.

  Parameters

  • sessionId: number

    the session id

  • catalog: string

    the catalog

  • query: string

    the jdbc query

  • maxRows: number

    the max rows for the table

  Returns Promise<Table>

  a promise that resolves to a table

Static getInstance

• getInstance(object): JdbcApiService

• Gets a new JsJdbcApiService instance.

  Parameters

  • object: WidgetExportedObject | Table | Widget | TotalsTable | TreeTable | PartitionedTable

    some instance that lives on the server to be connected to.

  Returns JdbcApiService

  a new JsJdbcApiService instance