Parameters

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read

    • The following parameters are available in a direct JDBC probe.

    Parameter Description
    jdbc_driver Required. Java class name for the JDBC driver to use, the currently supported drivers are:
    • Oracle: oracle.jdbc.OracleDriver
    • Microsoft SQL Server: com.microsoft.sqlserver.jdbc.SQLServerDriver
    • MySQL: com.mysql.jdbc.Driver
    Example 
    com.microsoft.sqlserver.jdbc.SQLServerDriver
    Parameter Description
    connection_string Required. JDBC connection string/URL for defining the connection, usually contains information about the database server and name, the user ID and password for conenctiong to the database. The syntax is vendor specific, refer to the following links for reference:
    • Oracle: [jdbc:oracle:thin:<username/password>@<database>]
    • Microsoft SQL Server: [jdbc:sqlserver://localhost;user=MyUserName;password=*****;]
    • MySQL - [jdbc:mysql://localhost/database?user=username%26password=passwd]
    Example 
    jdbc:sqlserver://xxx.service-now.com;
databaseName=SMS;
user=sms_user;
password=sms_password;
    Parameter Description
    work Required if not using the table_name parameter short cut.

    Parent element of an XML fragment describing the SQL command to execute.
    Example 
    ...
  <parameter name= "work" ><select table = "System_DATA" where = "InstanceKey=692" ><MachineID /><SMSID0 /></select></parameter>
  ...
    Parameter Description
    query_timeout Optional during SELECT. Number of seconds the JDBC driver will wait for a query (SELECT) to complete. Zero means no timeout. If timeout is exceeded, the integration considers the JDBC result inaccessible and places it in an error state.
    Parameter Description
    table_name Optional (except required during count_rows == true).

    Alternate way of executing a select * query; instead of using the work element. Equivalent to executing select * from <table_name>.
    Parameter Description
    count_rows Optional. Indicates whether a select count(*) query should return the number of rows (true/false). The result of the count will be returned as a row_count element in the result element.
    Parameter Description
    query Optional. Type of query. Possible choices are "All Rows from Table" or "Specific SQL". If "Specific SQL", the sql_statement will be required to specify the SQL statement.
    Parameter Description
    sql_statement Optional. Use a specific SQL query. The presence of this element executes a direct query specified in the value attribute.
    Example 
    ...
  select * from any_table where id = 123
  ...
    Parameter Description
    skip_sensor Optional. Determines if Discovery will attempt to process the ECC input from the JDBCProbe. Default = true
    For example, to query a table using a direct JDBC probe, requires the following parameters:
    • JDBC driver class name
    • JDBC connection string
      • Database server
      • Database name
      • User name
      • User password
    • The table name
    Figure 1. Queue form