SQL 2 Excel Pro - Using a Custom Database Driver

You can define your own custom database driver if there are no supplied driver for your database, or if you are missing a required extension for the supplied driver. As long as you have some way of connecteing and querying your database through PHP then you should be able to define a custom driver for SQL 2 Excel Pro.

SQL 2 Excel Pro ships with a sample driver that you can use as a starting point. The sample driver is located here:

./administrator/components/com_sql2excel/helpers/driver_sample.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147 <?php /********************************************************************** * * Sample Custom Database Connection Script for a MySQL database * * Note: SQL 2 Excel Pro comes with a built-in driver for MySQL * so it doesn't make much sense for writing a custom driver. * This code is just supplied as an example on how to write * a custom driver. You can test this driver against your * Joomla database before you start writing your own driver. * **********************************************************************/ // No direct access defined( '_JEXEC' ) or die( 'Restricted access' ); class sql2excel_customDB { /************************************************************* * * connect() * * Returns: * - Database Connection Object if successful * - NULL if unsuccessful * **************************************************************/ function connect($hostname, $database, $username, $password, $test=0) { $option = array (); $option ['driver'] = 'mysql'; $option ['host'] = $hostname ; $option ['user'] = $username; $option ['password'] = $password; $option ['database'] = trim($database); $option ['prefix'] = 'jos_'; $db = JFactory::getDBO (); $db = & JDatabase::getInstance ($option); if ( get_class($db) != 'JDatabaseMySQL' ) { // No valid connection! Return NULL if ( $test == 1 ) { // Output Debug Information for Connection Test print '<p><font color="red">Database Connection Error :</font> </p>'; print '<pre>'; print_r($db); print '</pre>'; } $db = null; } return $db; } /************************************************************* * * query() * * Returns an array with result objects if successful * * Expeccted array format is shown below. * * SELECT id, title FROM jos_content LIMIT 0,2 * * * Array * ( * [0] => stdClass Object * ( * [id] => 1 * [title] => Welcome to Joomla! * ) * * [1] => stdClass Object * ( * [id] => 2 * [title] => Newsflash 1 * ) * ) * * * * * * Return Error Message (as a string) if unsuccessful **************************************************************/ function query($db, $query,$returnResults=1) { if ( $db ) { $db->setQuery( $query ); if ( $returnResults ) { // Query returning reults $rows = $db->loadObjectList(); if ( !$rows ) { if ( is_null($rows) ) { // Return error message return $db->getErrorMsg(); } else { // No results return ''; } } else { return $rows; } } else { // No returned results (Update query from Scheduler etc) $ret = $db->query(); if ( $ret ) { return true; } else { return $db->getErrorMsg(); } } } else { return false; } } /************************************************************* * * test() * * Optional Query Test Function * * **************************************************************/ function test($db) { $ret = false; if ( $db ) { $query="SELECT id, title from jos_content LIMIT 0,2"; $rows = sql2excel_customDB::query($db, $query); return $rows; } } } ?>

Tips for writing your own driver

Sample Custom Drivers