Providing Connection Information When Registering Datasources

From RapidSQL
Jump to: navigation, search

Go Up to Manually Registering or Editing Datasources

Connection information is provided on a DBMS platform basis. The following topics describe platform-by-platform descriptions of the required and optional connection information:

Providing DB2 Connection Information When Registering Datasources

The Datasource Registration Wizard’s Connection Information panel lets you provide details required to establish a connection to a DB2 datasource. Available options depend on the Registration Type value selected.

The following table describes these settings:

Registration Type Option/Description

Simple

Host/Instance - The network name of the machine hosting the datasource.

Port - This defaults to 50000 but can be overwritten.

Database - The name of the database this user should connect to.

Datasource Name - This is the name of the datasource as it will appear in the Navigator.

Use alias from IBM client

Server - Select from the names of servers defined in the IBM client.

Datasource Name - This is the name of the datasource as it will appear in the Navigator.

Use Data from the LDAP Server

This option is only enabled if LDAP is enabled and configured on the Options Editor’s LDAP Configuration tab. For details, see LDAP Configuration Options.

Server - Select from the names of servers obtained from the LDAP server.

Host/Instance - The network name of the machine hosting the datasource.

Port - This defaults to 50000 but can be overwritten.

Database - The name of the database this user should connect to.

Datasource Name - The datasource as it will appear in the Navigator.

Keep the following in mind when registering a DB2 datasource:

  • The Options Editor lets you indicate preferences, select options, and provide details not available with the Datasource Registration Wizard. For details, see Connection Options.
  • Consult DB2 documentation for detailed information on general LDAP support, supported LDAP servers, and client configuration before trying to register LDAP-specified datasources. For assistance, see Accessing Third Party Documentation.
  • For more general information on registering datasources, see Manually Registering or Editing Datasources.

Providing MySQL Connection Information When Registering Datasources

The Datasource Registration Wizard’s Connection Information lets you provide details required to establish a connection to a MySQL datasource. The following table describes these setting:

Option Description

Server

Enter the name of the host, for example doctest01.

Port (optional)

The default port is 3306. You do not need to enter this information.

Default Database

You must enter the name of the default database.

Datasource Name

This field is automatically populated with the server name, but you can rename it to whatever you want.

Note: The Options Editor lets you indicate preferences, select options, and provide details not available with the Datasource Registration Wizard. For details, see Connection Options.

For more general information on registering datasources, see Manually Registering or Editing Datasources.

Providing Oracle Connection Information When Registering Datasources

The Datasource Registration Wizard’s Connection Information lets you provide details required to establish a connection to an Oracle datasource. Available options depend on the Registration Type value selected.

The following table describes these setting:

Registration Type Options/Description

Simple

Host - Manually enter the name of the host machine.

Port -The default is 1521, but you can change it to wherever the Oracle listener is set up.

SID/Service Name - Enter the SID or Service Name to correspond with the option you select.

Instance Name- The specific name used to identify the Oracle instance (the SGA and the Oracle processes).

Datasource Name - The field is automatically populated with the host name, but you can change it.

Use Connection Descriptor

Connect Descriptor - Provide a TNS Connect String, a connect identifier that defines the parameters that need the Oracle Net Service to connect to a database service.

Datasource Name - The field is automatically populated with the host name, but you can change it.

Use TNS Names alias

You can specify a non-default TNSNAMES.ORA file using the Options editor. For details, see Connection Options - Oracle.

Oracle Alias - The dropdown is populated with server names from the TNSNAMES.ORA file. Select an Oracle alias.

Connect Descriptor - A read-only field that displays the TNS Connect String obtained from the alias definition from the TNSNAMES.ORA file.

Datasource Name - The field is automatically populated with the host name, but you can change it.

Use Data from the LDAP Server ()

This option is only enabled if LDAP is enabled and properly configured on the Options Editor’s LDAP Configuration tab. For details, see LDAP Configuration Options.

Oracle Alias - The dropdown is populated with the names of servers obtained from the LDAP server specified on the Options Editor’s LDAP Configuration tab.

Connect Descriptor - A read-only field that displays the TNS Connect String obtained from the alias definition from the LDAP server.

Datasource Name - The field is automatically populated with the host name, but you can change it.

Keep the following in mind when registering an Oracle datasource:

  • You can register an Oracle ASM instance directly using the Datasource Registration Wizard. No Datasource Navigator tree is available when connecting to the ASM instance. The ISQL Editor is available with this type of connection.
  • Consult Oracle documentation for detailed information on general LDAP support, supported LDAP servers, and client configuration before trying to register LDAP-specified datasources. For assistance, see Accessing Third Party Documentation.
  • For more general information on registering datasources, see Manually Registering or Editing Datasources.

Providing PostgreSQL Connection Information When Registering Datasources

The Datasource Registration Wizard’s Connection Information lets you provide details required to establish a connection to a PostgreSQL datasource. The following table describes these settings:

Option Description

Host

The host name for the PostgreSQL Server.

Port

The port that the PostgreSQL server is listening on.

Database

The name for the database to connect to.

Datasource Name

This field automatically populates with the host name. You can change it to whatever you want.

Note: The Options Editor lets you indicate preferences, select options, and provide details not available with the Datasource Registration Wizard. For details, see Connection Options.

For more general information on registering datasources, see Manually Registering or Editing Datasources.

Providing SQL Server Connection Information When Registering Datasources

The Datasource Registration Wizard’s Connection Information lets you provide details required to establish a connection to a SQL Server datasource. The following table describes these setting:

Note: If you are registering a named instance on a server, you are restricted to use of the Use Network Library Configuration/Alias method below. Prior to registering the datasource, use the SQL Server Configuration Manager to create an alias to the instance, making it available as an Alias selection on the Connection Information panel.
Option Description

Simple

Protocol (TCP/IP or Named Pipes) - You need to select one or the other to register a SQL Server database.

Host - The host name.

Port - Depending on your section, you can optionally indicate the port for TCP/IP or the pipe name depending on your means of connection.

Default DB - Optionally give the default name for the database.

Datasource Name - The field is automatically populated with the host name, but you can rename to whatever you want.

Use Network Library Configuration

Use Encryption - Enables multi-protocol encryption.

Alias - Select an alias.

Protocol (TCP/IP or Named Pipes) - You need to select one or the other to register a SQL Server database.

Host- Displays the host name.

Port - Depending on your section, you can optionally indicate the port for TCP/IP or the pipe name depending on your means of connection.

Default DB - Optionally give the default name for the database.

Datasource Name - The field is automatically populated with the host name, but you can rename to whatever you want.

Note: The Options Editor lets you indicate preferences, select options, and provide details not available with the Datasource Registration Wizard. For details, see Connection Options.

For more general information on registering datasources, see Manually Registering or Editing Datasources.

Providing Sybase ASE Connection Information When Registering Datasources

The Datasource Registration Wizard’s Connection Information lets you provide details required to establish a connection to a Sybase ASE datasource. The following table describes these settings:

Registration Type Option/Description

Simple

Use SSL Encryption - If this option is selected, the JDBC connection will be established using SSL encryption

Host - Manually enter the name of the host.

Port - There is no default for this optional field.

Default DB - Optionally give the default name for the database.

Datasource Name - This field automatically populates with the server name. You can change it to whatever you want.

Use alias information from the SQL.INI FILE

Sybase Server - Select a server from the dropdown

Host - Automatically populated when you select an alias.

Port - There is no default for this optional field.

Default DB - Optionally give the default name for the database.

Datasource Name - This field automatically populates with the server name. You can change it to whatever you want.

Use data from the LDAP server

Use SSL Encryption - The connection will be established using SSL encryption.

Sybase Server - Select a server from the dropdown

Host - Automatically populated when you select an alias.

Port - There is no default for this optional field.

Default DB - Optionally give the default name for the database.

Datasource Name - This field automatically populates with the server name. You can change it to whatever you want.

Note: The Options Editor lets you indicate preferences, select options, and provide details not available with the Datasource Registration Wizard. For details, see Connection Options.

For more general information on registering datasources, see Manually Registering or Editing Datasources.

Providing Sybase IQ Connection Information When Registering Datasources

The Datasource Registration Wizard’s Connection Information lets you provide details required to establish a connection to a Sybase IQ datasource. The following table describes these settings:

Option Description

Host

The host name for the Sybase IQ Server.

Port

The port that Sybase IQ is listening on.

Database

The name for the database to connect to.

Datasource Name

This field automatically populates with the host name. You can change it to whatever you want.

Note: The Options Editor lets you indicate preferences, select options, and provide details not available with the Datasource Registration Wizard. For details, see Connection Options.

For more general information on registering datasources, see Manually Registering or Editing Datasources.

Providing Teradata Connection Information When Registering Datasources

The Datasource Registration Wizard’s Connection Information lets you provide details required to establish a connection to a Teradata datasource. The following table describes these settings:

Option Description

Host

The host name for the Teradata Server.

Port

The port that the Teradata server is listening on.

Database

The name for the database to connect to.

Datasource Name

This field automatically populates with the host name. You can change it to whatever you want.

Note: The Options Editor lets you indicate preferences, select options, and provide details not available with the Datasource Registration Wizard. For details, see Connection Options.

For more general information on registering datasources, see Manually Registering or Editing Datasources.

Providing Connection Information When Registering a Generic JDBC Datasource

The Datasource Registration Wizard’s Connection Information lets you provide basic information details required to establish a connection to a generic JDBC datasource.

Note: For requirements and functionality restrictions for generic JDBC connections, see Generic JDBC/ODBC Connectivity.

The following table describes the settings on this panel:

Option Description

JDBC driver to use

If you are defining a datasource using a custom JDBC driver, this field is automatically populated with the value you entered in the Template Connect URL for new data source field. For more information. see Providing details for a new custom JDBC driver.

Connection URL

Type a valid connection URL or edit the URL template to provide a valid connection URL.

Datasource Name

This is the name that will appear in the Datasource Navigator.

Note: In addition to basic connection properties, you can also specify provider-specific JDBC properties. For details, see Providing Custom Driver Properties When Registering Datasources.

Take one of the following actions:

  1. To specify a JDBC driver that you have not used before, click Manage to register a new driver. For more information, see Providing details for a new custom JDBC driver.
  2. To use a custom JDBC driver you have already registered, select that driver from the JDBC driver to use dropdown.

Providing details for a new custom JDBC driver

When registering a datasource, if you select a generic JDBC connection, you must specify the installed JDBC driver to be used. If you have not used that driver, you can register that driver while defining a datasource.

Note: Before setting up a custom driver, consult the documentation for that driver to obtain details such as the driver class and connection URL for that driver type.

To specify a new custom JDBC driver

  1. Open a datasource registration dialog. For details, see Manually Registering or Editing Datasources.
  2. From the Available database types list, select Generic JDBC.
  3. On the Connection Information page, click Manage. The JDBC Driver Editor opens.
  4. In the Name field, type a name or description for the new driver.
  5. Click the Add button associated with the Driver Archives list and use the Open dialog to locate and select the library or archive for the driver.
  6. In the Class field, type the driver class.
  7. In the Template Connect URL for new data source field, provide a connection URL template. There are no constraints on the value that you enter. When providing details on the Datasource Registration Wizard’s Connection Information panel, the template will automatically be entered in the Connection URL field, letting you provide actual values for any placeholders you provide in the URL template entered here.

Providing Connection Information When Registering a Generic ODBC Datasource

The Datasource Registration Wizard’s Connection Information lets you provide details required to establish a connection to a generic ODBC datasource.

Note: For requirements and functionality restrictions for generic ODBC connections, see Generic JDBC/ODBC Connectivity.

The following table describes the settings on this panel:

Use Connect String Opinion/Description

Unselected

Datasource Name - Provide the name that will appear in the Datasource Navigator for this datasource.

DSN - Provide the DSN for the datasource.

Selected

Datasource Name - Provide the name that will appear in the Datasource Navigator for this datasource.

Connect String - Provide the full connection string for the datasource.

Note: Consult the documentation for the ODBC driver and the datasource you are connecting to for details on DSN and connect string requirements.