comet.CSQL¶

class comet.CSQL¶

CSQL represents an active SQL data connection.

Methods¶

CSQL.getServer()¶

Get the server name of this connection.

Returns:: The server name
Return type:: str
Raises:: CometError – On internal error
Available:: InDesign® comet_pdf® Illustrator®
CScript:: sql::server

CSQL.getUser()¶

Get the user name this connection was established with.

Returns:: The user name
Return type:: str
Raises:: CometError – On internal error
Available:: InDesign® comet_pdf® Illustrator®
CScript:: sql::user

CSQL.getDBName()¶

Get the database name this connection was established with.

Returns:: The database name
Return type:: str
Raises:: CometError – On internal error
Available:: InDesign® comet_pdf® Illustrator®
CScript:: sql::dbname

CSQL.getClient()¶

Get the client name this connection was established with.

Returns:: The client name
Return type:: str
Raises:: CometError – On internal error
Available:: InDesign® comet_pdf® Illustrator®
CScript:: sql::client

CSQL.getCharset()¶

Get the character set this connection was established with.

Returns:

The character set

0: System charset
1: UTF-8
2: Unicode 16 Bit
3: Unicode 32 Bit

Return type:

Raises:

CometError – On internal error

Available:

InDesign® comet_pdf® Illustrator®

CScript:

CSQL.createQuery()¶

Creates a new transaction query object for this connection.

Returns:: A new query object
Return type:: CQuery
Raises:: CometError – On internal error
Available:: InDesign® comet_pdf® Illustrator®
CScript:: sql::query

Special methods¶

CSQL.__repr__()¶

String representation.

Returns:

<CSQL> Label: Label

Example¶

<CSQL> Label: Comet Project DB

Return type: