Appboard/old/database data adapters - Revision history

imported>Jason.nicholls at 16:36, 17 July 2014

2014-07-17T16:36:31Z

← Older revision		Revision as of 16:36, 17 July 2014
Line 1:		Line 1:
			{{DISPLAYTITLE:Database Data Adapters}}
			[[Category:AppBoard old]]
	There are three database data adapters to choose from: JDBC, [[appboard/old/sql_query_adapter\|JDBC SQL]], and MySQL. As each type of data adapter will require different information to connect to AppBoard, this page will assist you in understanding some of the specific options associated with '''database''' data adapters. For information on options used to connect a database data adapter, [[#Data Source Wizard - Connect\|skip to the Connect step]].		There are three database data adapters to choose from: JDBC, [[appboard/old/sql_query_adapter\|JDBC SQL]], and MySQL. As each type of data adapter will require different information to connect to AppBoard, this page will assist you in understanding some of the specific options associated with '''database''' data adapters. For information on options used to connect a database data adapter, [[#Data Source Wizard - Connect\|skip to the Connect step]].

imported>Jason.nicholls: moved Database Data Adapters to appboard/old/database data adapters

2014-07-17T16:36:00Z

moved Database Data Adapters to appboard/old/database data adapters

← Older revision	Revision as of 16:36, 17 July 2014
(No difference)

imported>Jason.nicholls at 16:34, 17 July 2014

2014-07-17T16:34:26Z

← Older revision		Revision as of 16:34, 17 July 2014
Line 1:		Line 1:
	There are three database data adapters to choose from: JDBC, [[~~SQL_Query_Adapter~~\|JDBC SQL]], and MySQL. As each type of data adapter will require different information to connect to AppBoard, this page will assist you in understanding some of the specific options associated with '''database''' data adapters. For information on options used to connect a database data adapter, [[#Data Source Wizard - Connect\|skip to the Connect step]].		There are three database data adapters to choose from: JDBC, [[appboard/old/sql_query_adapter\|JDBC SQL]], and MySQL. As each type of data adapter will require different information to connect to AppBoard, this page will assist you in understanding some of the specific options associated with '''database''' data adapters. For information on options used to connect a database data adapter, [[#Data Source Wizard - Connect\|skip to the Connect step]].

imported>Jason.nicholls at 18:06, 16 July 2014

2014-07-16T18:06:45Z

← Older revision		Revision as of 18:06, 16 July 2014
Line 111:		Line 111:
	\|Time to wait before timing out on connecting to the datasource.		\|Time to wait before timing out on connecting to the datasource.
	\|-		\|-
	\|'''[[~~Caching_And_Polling~~\|cacheTimeout]]'''		\|'''[[appboard/old/caching_and_polling\|cacheTimeout]]'''
	\|Time limit before re-loading results from the database.		\|Time limit before re-loading results from the database.
	\|-		\|-

imported>Andy.hopper: /* Data Source Wizard - Connect */

2013-08-29T14:04:47Z

Data Source Wizard - Connect

← Older revision		Revision as of 14:04, 29 August 2013
Line 107:		Line 107:
	\|'''password'''		\|'''password'''
	\|User password credential used to connect to database.		\|User password credential used to connect to database.
	\|-
	~~\|'''poolsize'''~~
	~~\|Number of connections to pool. This adapter re-uses connections for efficiency.~~
	\|-		\|-
	\|'''timeout'''		\|'''timeout'''

imported>Mike.berman: add netcool objectserver section

2012-12-11T20:46:24Z

add netcool objectserver section

@@ Line 15: / Line 15: @@
 ===Why use a JDBC SQL query adapter?===
 When using the basic JDBC data adapter, you are presented with the visible tables and columns within those tables with little control over how they are formatted or filtered.  This is quick and easy when the data exists in the form it is needed, but often there is a need for more control.  Examples of situations where the JDBC SQL adapter is required include:
@@ Line 24: / Line 23: @@
 *the raw data set is too large to handle in memory and you need to select a dynamic subset of that data

imported>Cmace: copied with caching and polling update

2012-08-20T19:17:02Z

copied with caching and polling update

← Older revision		Revision as of 19:17, 20 August 2012
Line 61:		Line 61:
	\|Time to wait before timing out on connecting to the datasource.		\|Time to wait before timing out on connecting to the datasource.
	\|-		\|-
	\|'''cacheTimeout'''		\|'''[[Caching_And_Polling\|cacheTimeout]]'''
	\|Time limit before re-loading results from the database.		\|Time limit before re-loading results from the database.
	\|-		\|-

imported>Cmace: copied from internal

2012-06-26T15:10:11Z

copied from internal

New page

There are three database data adapters to choose from: JDBC, [[SQL_Query_Adapter|JDBC SQL]], and MySQL. As each type of data adapter will require different information to connect to AppBoard, this page will assist you in understanding some of the specific options associated with '''database''' data adapters. For information on options used to connect a database data adapter, [[#Data Source Wizard - Connect|skip to the Connect step]].

==JDBC==

This adapter retrieves a filtered set of tables from a RDBMS to create multiple Data Collections. Equivalent to executing "select * from <table_name>" for the selected tables. The adapter supports connectivity to SQL Server, Oracle, SQL Anywhere, Postgres SQL Hypersonic (HSQLDB), H2, MySQL, and DB2. Advanced configuration may be set per entity to control the caching of a particular data set or to limit the amount of data by using a "where" clause.

==JDBC SQL==

This adapter retrieves data from a RDBMS using SQL queries to create a single data set. The adapter supports connectivity to SQL Server, Oracle, SQL Anywhere, Postgres SQL Hypersonic (HSQLDB), H2, MySQL, and DB2. This is typically used when a JOIN is required to produce a more appropriate view of the data (without unnecessary associations) or for performance reasons.

===Why use a JDBC SQL query adapter?===

When using the basic JDBC data adapter, you are presented with the visible tables and columns within those tables with little control over how they are formatted or filtered. This is quick and easy when the data exists in the form it is needed, but often there is a need for more control. Examples of situations where the JDBC SQL adapter is required include:

*the required data comes from a SQL stored procedure
*some SQL calculations need to be done (eg. date calculations, etc)
*complex joins need to be done in the source
*the raw data set is too large to handle in memory and you need to select a dynamic subset of that data

==MySQL==

This adapter retrieves a filtered set of tables from a MySQL RDBMS to create multiple Data Collections and is provided as a secondary adapter to the JDBC adapter. Advanced configuration may be set per entity to control the caching of a particular data set or to limit the amount of data by using a "where" clause.

==Data Source Wizard - Connect==

The Data Source Wizard begins with the "Connect" step. Here you must decide on the template for your data source, and fill in the necessary information. These are the possible boxes you will need to fill in for a database data source:

{|border="1" cellpadding="10"
!''Name''
!''Description''
|-
|'''url'''
| The JDBC connection string/URL for defining the connection. This typically contains information about the database server and name, the user id, a password for connecting to the database, and an Oracle SID at the end which uniquely identifies the name of a particular database to connect to. Example: <tt>jdbc:mysql://myservername:3306/mydbname</tt>. The default connection string provided when you create the JDBC/Oracle adapter Data Source in AppBoard is the following: <tt>jdbc:oracle:thin:@localhost:1521:portal</tt>. Note that the sample URL string contains an Oracle SID at the end ("portal"), which uniquely identifies the name of a particular database to connect to. It is recommended that you make sure the connection string includes this SID so the connection can be made between AppBoard and the database. You may need to ask the database or application administrator to provide the Oracle SID for the database. Example Oracle URL: <tt>jdbc:oracle:thin:@servername:1521:OracleSID</tt>
|-
|'''driver'''
| The Java class name for the JDBC driver. Example: <tt>oracle.jdbc.driver.OracleDriver</tt>
|-
|'''username'''
|User name credential used to connect to database.
|-
|'''password'''
|User password credential used to connect to database.
|-
|'''poolsize'''
|Number of connections to pool. This adapter re-uses connections for efficiency.
|-
|'''timeout'''
|Time to wait before timing out on connecting to the datasource.
|-
|'''cacheTimeout'''
|Time limit before re-loading results from the database.
|-
|'''catalogName'''
|Database catalog name. It is not required, used to limit the set of tables found on the search.
|-
|'''schemaName'''
|The database schema name. It is not required, used to limit the set of tables found on the search.
|-
|'''tableNameRegex'''
|Regular expression that defines the database tables that will be returned by the adapter. It is not required, but may be used to limit the set of tables found on the search. For example, if you had a couple of tables called Services and Locations, a useful regex to enter in that box would be “<nowiki>(Services|Locations)</nowiki>” - without the quotes. This is case-sensitive, and would match tables with names such as ServicesA, ServicesUS, LocationsB, or any table that contains either "Services" or "Locations" somewhere in the name. If you made the regex "^(<nowiki>Services|Locations</nowiki>)$" then it would only match exactly those names since the ^ and $ anchor the beginning and the end of the string.
|-
|'''sqlQuery'''
|SQL query statement to be run on the database. Typically used when it is necessary to perform more advanced JOINS to produce a more appropriate view of the dataset.
|-
|}