Оригинал на английском: http://phplens.com/lens/adodb/docs-adodb.htm
Перевод Феськов Кузьма <kuzma@russofile.ru.> http://kuzma.russofile.ru
ADODB - русская документация (часть 1)
v4.62 2 Apr 2005 (c) 2000-2005 John Lim (jlim#natsoft.com)
v4.62 14 Июль 2005 (c) 2005 Feskov Kuzma (kuzma#russofile.ru)
Это программное обеспечение распространяется под двумя лицензиями:
BSD-style и LGPL. Это означает, что вы можете использовать его в
компилируемых и коммерческих продуктах.
Содержание
* Вступление
* Уникальные возможности ADODB
* Инструкция по установке
* Минимальная установка
* Инициализация класса
* Поддержка Data Source Name (DSN)
* Примеры соединения с базами данных
* Настройка ADODB для более высокой производительности
* Дополнительные подсказки
* Модернизация ADODB
* Возможности PHP5
* Поддерживаемые базы данных
Вступление
Функции доступа к базам данных в PHP не стандартизированы. Это создает
потребность в классе, который бы скрыл эту разницу в программном
интерфейсе при работе с различными базами (инкапсулировать различия),
позволяя легко переключаться с одной базы данных на другую. Для работы
вам потребуется PHP версии 4.0.5 и выше, поскольку в скриптах
используется str_replace.
В настоящее время поддерживается работа с базами MySQL, Oracle,
Microsoft SQL Server, Sybase, Sybase SQL Anywhere, Informix,
PostgreSQL, FrontBase, SQLite, Interbase (Firebird and Borland
variants), Foxpro, Access, ADO, DB2, SAP DB и ODBC. Также были
успешными попытки подсоединиться к Progress и CacheLite. Мы надеемся,
что пользователи создадут драйвера и для других баз данных.
PHP поддерживает переменные сессии. Вы можете хранить данные сессии в
базе при помощи ADOdb для истинной мобильности и масштабируемости.
Дополнительную информацию ищите в Adodb-session.php.
Для того, чтобы писать настоящий переносимый код - почитайте
здесь.
Уникальные возможности ADODB
* Легок в изучении для Windows-программистов, поскольку использует
синтаксис близкий к Microsoft ADO.
* В отличие от других PHP классов, которые в основном фокусируются
только на SELECT-запросах, мы обращаем внимание также на команды
вставки (INSERT) и изменения (UPDATE) данных, которые очень быстро
могут модернизироваться под потребности различных баз данных.
Также существуют методы для обработки дат, конкатенации строк и
экранирования строк по правилам различных баз данных.
* Система мето-типов построена так, чтоб вы могли быть уверенными,
что сохраняемые вами данные, например CHAR, TEXT, STRING, будут
одинаковыми для всех баз данных.
* Легкая переносимость, потому что все низкоуровневые функции
вынесены отдельно и вам нет необходимости вносить изменения в ядро
класса.
* Переносимость на уровне создания таблиц и индексов.
* Контроль работы базы данных и тонкая настройка производительности.
* Поддержка сессии на уровне базы данных, поддержка истечения
времени сессии и уведомлений.
Инструкция по установке
Проверьте, что вы используете PHP 4.0.5 и выше. Распакуйте все файлы в
папку, доступную для вебсервера.
Для проверки попробуйте запустить несколько файлов из обучающего
курса. Убедитесь, что вы вы правильно установили параметры
подключения. Для отладки используйте команду $db->debug = true, как
показано ниже:
include('adodb/adodb.inc.php');
$db = ADONewConnection($dbdriver); # например 'mysql' или 'postgres'
$db->debug = true;
$db->Connect($server, $user, $password, $database);
$rs = $db->Execute('select * from some_small_table');
print "<pre>";
print_r($rs->GetRows());
print "</pre>";
Минимальная установка
Для разработчиков, которые нуждаются в минимальном наборе функций,
рекомендуем установить следующие файлы:
* adodb-error.inc.php и lang/adodb-$lang.inc.php (если вы
используете MetaError())
* adodb-csvlib.inc.php (если вы используете кэширование запросов -
CacheExecute(), и др.)
* adodb-exceptions.inc.php и adodb-errorhandler.inc.php (если вы
используете adodb error handler или исключения PHP5).
Инициализация класса
Для запуска ADODB требуется 2 файла: первый - adodb/adodb.inc.php
(содержит базовые функции, которые используются во всех классах) и,
второй, - adodb/driver/adodb-????.inc.php (определяет специфические
для конкретной базы данных функции).
Всякий раз, как вы соединяетесь с базой данных, создается новый объект
(ADONewConnection($driver)). NewADOConnection($driver) -
альтернативное название предыдущей функции.
На этом этапе вы никак не связаны с базой данных. Вам надо
определиться - будете ли вы использовать постоянное или непостоянное
соединение. Преимущество постоянного соединения в том, что оно
быстрее, поскольку связь с базой данных никогда не теряется (даже
когда вы даете команду Close()). Непостоянные соединения требуют
гораздо меньше ресурсов, однако повышают вероятность того, что ваша
база данных и веб-сервер будут перегружены.
Для постоянного соединения используйте команду $conn->PConnect(). Для
непостоянного соединения - $conn->Connect(). Некоторые базы данных
поддерживают также Nconnect() - эта команда вынуждает создать новое
соединение.
Важное замечание: Если вы создаете два соединения, но оба они
используют одинаковое имя пользователя (userid) и пароль, PHP не
станет создавать новое соединение, а примет для работы первое, ранее
созданное. Это может привести к проблемам в том случае, если вы от
имени одного пользователя пытались соединиться к разным базам данных.
Решение данной проблемы состоит в том, чтобы всегда использовать
разное имя пользователя (userid) для разных баз данных, или
использовать команду Nconnect().
Поддержка Data Source Name (DSN)
Начиная с версии ADODB 4.51 вы можете соединяться с базой передавая
NewADOConnection() (или ADONewConnection()) параметры в виде DSN:
Для всех драйверов справедливо: если вы задали установить постоянное и
непостоянное соединения одновременно - будет установлено постоянное
соединение. Debug - включает отладку. Fetchmode - вызывает функцию
SetFetchMode().Если вы не указали никакого значение, то значение будет
выставлено в 1.
ADODB DSN совместимы с версией 1.0 формата PEAR DB's DSN Format.
Примеры соединения с базами данных
MySql и большинство других баз данных
Mysql соединение имеет очень простой формат и параметры аналогичны
mysql_connect:
# или DSN
$dsn = 'mysql://user:pwd@localhost/mydb';
$conn = ADONewConnection($dsn); # нет необходимости в Connect()
# или постоянное DSN
$dsn = 'mysql://user:pwd@localhost/mydb?persist';
$conn = ADONewConnection($dsn); # нет необходимости в PConnect()
# Более сложный пример:
$pwd = urlencode($pwd);
$flags = MYSQL_CLIENT_COMPRESS;
$dsn = "mysql://user:$pwd@localhost/mydb?persist&clientflags=$flags";
$conn = ADONewConnection($dsn); # нет необходимости в Pconnect()
Для большинства драйверов вы можете использовать стандартную функцию
Connect($server, $user, $password, $database), или DSN (начиная с
версии 4.51). Исключения будут описаны ниже.
PostgreSQL
$dsn = 'postgres://user:pwd@localhost/mydb?persist'; # persist необязательный параметр
$conn = ADONewConnection($dsn); # нет необходимости в Connect/PConnect
LDAP
Вот пример для работы с LDAP сервером. Благодарим Джоша Элдридджа за
драйвер и этот пример:
require('/path/to/adodb.inc.php');
/* Убедитесь, что вы задали эти параметры ДО вызова Connect() */
$LDAP_CONNECT_OPTIONS = Array(
Array ("OPTION_NAME"=>LDAP_OPT_DEREF, "OPTION_VALUE"=>2),
Array ("OPTION_NAME"=>LDAP_OPT_SIZELIMIT,"OPTION_VALUE"=>100),
Array ("OPTION_NAME"=>LDAP_OPT_TIMELIMIT,"OPTION_VALUE"=>30),
Array ("OPTION_NAME"=>LDAP_OPT_PROTOCOL_VERSION,"OPTION_VALUE"=>3),
Array ("OPTION_NAME"=>LDAP_OPT_ERROR_NUMBER,"OPTION_VALUE"=>13),
Array ("OPTION_NAME"=>LDAP_OPT_REFERRALS,"OPTION_VALUE"=>FALSE),
Array ("OPTION_NAME"=>LDAP_OPT_RESTART,"OPTION_VALUE"=>FALSE)
);
$host = 'ldap.baylor.edu';
$ldapbase = 'ou=People,o=Baylor University,c=US';
$dsn = 'firebird://user:pwd@localhost/mydb?persist&dialect=3'; # persist необязательный параметр
$conn = ADONewConnection($dsn); # нет необходимости в Connect/PConnect
SQLite
SQLite создаст файл базы данных, если его до сих пор небыло:
$conn = &ADONewConnection('sqlite');
$conn->PConnect('c:path osqlite.db'); # sqlite создаст файл, если его небыло
или DSN:
$path = urlencode('c:path osqlite.db');
$dsn = "sqlite://$path/?persist"; # persist необязательный параметр
$conn = ADONewConnection($dsn); # нет необходимости в Connect/PConnect
Oracle (oci8)
С oci8 вы можете устанавливать соединение множеством способов.
Обратите внимание, что способы работы с oci8 прекрасно подходят и для
более новых версий Oracle (9i и 10g).
а) PHP и Oracle находятся на одной машине, используют SID поумолчанию:
$conn->Connect(false, 'scott', 'tiger');
б) TSN Name определяется в файле tnsnames.ora (или ONAMES, или
HOSTNAMES), аналогично 'myTNS':
# или
$dsn = 'oci8://user:pwd@tnsname/?charset=WE8MSWIN1252';
$db = ADONewConnection($dsn);
DSN-less ODBC (примеры для Access, MSSQL и DB2)
ODBC DSN'ы могут быть созданы в панели настроек ODBC, или вы можете
использовать DSN-less соединения. Для использования DSN-less
соединений с ODBC вам понадобится PHP версии 4.3 или выше.
или, если вы предпочитаете использовать расширение mssql (который
ограничен функциональность mssql 6.5):
$db =& ADONewConnection('mssql');
$db->Execute('localhost', 'userid', 'password', 'northwind');
Если вы используете PHP версии меньше, чем 4.3.0, то DSN-less
соединения будут работать только с Microsoft's ADO, через, основанное
на Microsoft COM, API. Пример использования библиотеки ADODB и
Microsoft's ADO:
$rs = $db->Execute("select * from table");
$arr = $rs->GetArray();
print_r($arr);
Настройка ADODB для более высокой производительности
ADODB - это очень большая библиотека, которая всеже превосходит все
другие библиотеки PHP в производительности. Это происходит потому, что
она разработана в виде слоев, подобно луку, самые быстрые функции
расположены во внутреннем слое. Придерживайтесь использования
следующих функций для большей производительности:
Самый быстрый способ получить доступ к данным, это обращаться
непосредственно к массиву с данными $recordset->fields. Также
установите значения глобальным переменным $ADODB_FETCH_MODE =
ADODB_FETCH_NUM, и (для oci8, ibase/firebird и odbc) $ADODB_COUNTRECS
= false до того, как подключитесь к базе данных.
Используйте связанные параметры, если ваша база данных поддерживает
это, поскольку это улучшает повторное использование запросов.
Используйте систему тонкой настройки ADODB для быстрого выявления
узких мест. На время написания (Дек. 2003) это справедливо и для oci8
и odbc драйверов.
Наконец, убедитесь, что у вас установлен PHP акселератор кэширования,
например, APC, Turck MMCache, Zend Accelerator или ionCube.
Несколько примеров:
Быстрый доступ к данным в PHP:
$rs =& $rs->Execute($sql);
while (!$rs->EOF) {
var_dump($rs->fields);
$rs->MoveNext();
}
Если у вас установлено расширение ADODB, написанное на C, вы можете
заменить ваши запросы к $rs->MoveNex() на adodb_movenex($rs). Эта
команда удваивает скорость операции. Для того, чтобы получить записи
целиком, используйте GetArray(), которая использует высокоскоростную
функцию расширения adodb_getall($rs).
Execute() - это основной способ запуска запросов. Вы можете
использовать функции низкого уровня _Execute() и _query(), чтобы
уменьшить цепочку функций. Обе эти функции принимают теже самые
параметры, что и Execute().
Если вы не используете связанные параметры, или ваша база данных
поддерживает связанные параметры (без эмуляции) вы можете вызывать
_Execute() непосредственно. Вызов этих функций обходит эмуляцию
связанных параметров. _Execute() поддерживает отладку.
Если вам не требуется отладка, вы не используете связанные данные и
вам не нужны возвращаемые значения - используйте функцию _query(). Эта
функция хорошо подходит для вставки (INSERT), обновления (UPDATE) и
удаления (DELETE). Вызов функции _query() позволит вам обойти отладку,
эмуляцию связанных данных и обработку возвращаемых результатов.
Функция возвращает TRUE или FALSE.
Для Informix вы можете выключить scrollable курсоры командой
$db->cursorType = 0.
Модернизация ADODB
Вы вполне можете хотеть изменить ADODB под свои собственные нужды. К
счастью, вы легко можете поддерживать обратную совместимость расширяя
ADODB и используя переменную $ADODB_NEWCONNECTION.
$ADODB_NEWCONNECTION позволяет перекрыть поведение ADONewConnection().
ADONewConnection() проверяет эту переменную и вызывает функцию с
именем, сохраненным в этой переменной.
В следующем примере, новые функциональные возможности для объекта
соединения помещены в классы hack_mysql и hack_postgres7. Название
классов (навязанные соглашения) для обработки данных контролируются
при помощи переменной $rsPrefix. Здесь мы устанавливаем ее в
'hacks_rs_', это заставит ADODB использовать hacks_rs_mysql и
hacks_rs_postgres7 как классы для обработки данных.
class hack_mysql extends adodb_mysql {
var $rsPrefix = 'hack_rs_';
/* Ваши изменения здесь */
}
class hack_rs_mysql extends ADORecordSet_mysql {
/* Ваши изменения здесь */
}
class hack_postgres7 extends adodb_postgres7 {
var $rsPrefix = 'hack_rs_';
/* Ваши зменения здесь */
}
class hack_rs_postgres7 extends ADORecordSet_postgres7 {
/* Ваши изменения здесь */
}
$driver = 'hack_'.$driver;
$obj = new $driver();
return $obj;
}
include_once('adodb.inc.php');
Незабудьте вызывать конструктор родительского класса из вашего
конструктора. Если вы хотите использовать драйвер ADODB поумолчанию -
верните FALSE из hack_factory().
Возможности PHP5
Начиная с версии ADODB 4.02 класс прозрачно определяет, какую версию
PHP вы используете. В случае обнаружения PHP5 становятся доступными
следующие возможности:
* Foreach итераторы: это очень естественный способ обработки данных:
Обратите внимание, что достижение EOF не считается ни ошибкой ни
исключением. Если вы хотите использовать драйвер поумолчанию - верните
FALSE.
Поддерживаемые базы данных
Параметр 'Имя' - это то, что вы должны передать в функцию
NewADOConnection($name).
Колонка 'Тест' указывает, насколько хорошо код был проверен и
используется:
* A - хорошо проверенный и используемый многими людьми;
* B - проверен и годен к употреблению, однако некоторые особенности
не могут быть реализованы;
* C - экспериментальный драйвер, не может поддерживать все
возможности ADODB.
Колонка 'RecordCount()' показывает - возвращает ли эта функция
колличество запрошенных строк или возвращает -1, если SELECT выполнен.
Если указано 'Y/N' - происходит эмуляция, если глобальная переменная
$ADODB_COUNTRECS=true (это значение по умолчанию). Обратите внимание,
что для большого количества результатов лучше эту возможность
выключить, потомучто потребуется значительное количество памяти для
проведения расчетов. Также, эмуляция снижает скорость работы на
40-50%. Это эмулируется в большинстве баз данных кроме PostgreSQL и
MySql. Эта переменная проверяется каждый раз, когда вы запускаете
запрос, так что вы можете выбрать, какие данные вам считать.
ADODB - русская документация (часть 2)
v4.62 2 Apr 2005 (c) 2000-2005 John Lim (jlim#natsoft.com)
v4.62 14 Июль 2005 (c) 2005 Feskov Kuzma (kuzma#russofile.ru)
Это программное обеспечение распространяется под двумя лицензиями:
BSD-style и LGPL. Это означает, что вы можете использовать его в
компилируемых и коммерческих продуктах.
Содержание
* Учебник
* Пример 1: SELECT
* Пример 2: Расширенный SELECT с объектами полей
* Пример 3: INSERT (вставка)
* Пример 4: Отладка
* Пример 5: MySql и меню
* Пример 6: Подключение сразу к двум базам данных
* Пример 7: Генерация UPDATE и INSERT SQL запросов
* Пример 8: Организация постраничного вывода
* Пример 9: Экспорт данных в CVS или с разделением табуляцией
* Пример 10: Recordset фильтры
* Пример 11: Умные транзакции
Учебник
Пример 1: SELECT
Задача: Соединиться с Access Northwind DSN, показать первые 2 колонки
каждого ряда.
В этом примере мы создадим объект ADOCOnnection доступа к базе данных.
Соединение Pconnet - постоянное. Каждый раз, когда мы хотим сделать
запрос к базе данных - вызываем функцию ADOConnection.Execute(). Она
возвращает объект ACORecordSet, который, фактически, является
курсором, указывающим на текущую строку в массиве fields[]. Мы
используем MovieNext() для передвижения по рядам.
Обратите внимание: Полезная функция, которая не используется в данном
примере, SelectLimit(), позволяет ограничить количество запрашиваемых
рядов.
include('adodb.inc.php'); # подключаем основную библиотеку ADOdb
$conn = &ADONewConnection('access'); # создаем соединение
$conn->PConnect('northwind'); # соединяемся с MS-Access, northwind DSN
$recordSet = &$conn->Execute('select * from products');
if (!$recordSet)
print $conn->ErrorMsg();
else
while (!$recordSet->EOF) {
print $recordSet->fields[[ .']] '.$recordSet->fields.'
';
$recordSet->MoveNext();
}
$recordSet возвращает записи текущего ряда из массива
$recordSet->fields с числовыми индексами по номеру колонки (начиная с
0). мы используем функцию MoveNext() для перехода к следующему ряду.
EOF устанавливается в TRUE, когда мы достигаем конца. Если происходит
ошибка во время запроса, Execute() вернет FALSE вместо запрашиваемых
данных.
Массив $recordSet->fields генерируется PHP расширением для работы с
базой данных. Некоторые расширения дают только числовой индекс и не
дают индекса по названию колонки. Чтобы вызвать индексацию по названию
колонки, что является ассоциированным массивом, используйте функцию
SetFetchMode. Каждый результат будет сохранен в соответствии с ее
установками при создании результата функциями Execute или SelectLimit.
Для получения общего количества возвращенных данных, используйте
$recordSet->RecordCount(). Помните, что эта функция может вернуть -1,
в случае, если невозможно определить количество возвращенных рядов.
Пример 2: Расширенный SELECT с объектами полей
Делаем выборку из таблицы, показываем первые две колонки. Если вторая
колонка - дата или тайм штамп, то переформатируем дату в американский
формат.
include('adodb.inc.php'); # загружаем библиотеку ADOdb
$conn = &ADONewConnection('access'); # создаем соединение
$conn->PConnect('northwind'); # соединяемся с базой MS-Access, northwind dsn
$recordSet = &$conn->Execute('select CustomerID,OrderDate from Orders');
if (!$recordSet)
print $conn->ErrorMsg();
else
while (!$recordSet->EOF) {
$fld = $recordSet->FetchField(1);
$type = $recordSet->MetaType($fld->type);
$recordSet->MoveNext();
}
$recordSet->Close(); # не обязательно
$conn->Close(); # не обязательно
В этом примере мы проверяем тип второй колонки функцией FetchField().
Эта функция возвращает объект как минимум с тремя полями:
* name: имя колонки;
* type: родной тип поля;
* max_lenght: максимальная длина поля. Некоторые базы, например
MySql, неправильно возвращают максимальную длину поля. В этих
случаях max_leght будет выставлено в -1.
Далее, мы используем функцию MetaType(), чтобы перевести родной тип
поля в родовой тип. В настоящее время определены следующие родовые
типы:
* C: текстовое поле, которое нужно показывать как тег <input
type='text'>;
* X: TeXt, большое текстовое поле, которое необходимо показывать как
тег <textarea>;
* B: Blobs, или бинарные объекты большого объема. Чаще всего -
картинки;
* D: Date, дата;
* T: Timestamp, тайм штамп;
* L: логическое поле (булевое (true/false) или бит);
* I: Integer, целое число;
* N: Numeric, включает автоприращение (autoincrement), число, число
с точкой, реальное и целое число;
* R: Serial, Включает serial, целые числа с автоприращением. Это
работает в отдельных базах данных.
Если metatype имеет тип дата или тайм штамп, то мы печатаем его с
использованием заданного пользователем формата в функцией UserDate(),
которая конвертирует дату формата PHP SQL в формат, нужный
пользователю. Другой вариант использования MetaType() - это приведение
(проверка) формата данных перед помещением их в базу данных.
Пример 3: INSERT (вставка)
Вставляем строку в таблицу заказов, которая содержит даты и строки,
требующие обработки перед вставкой в базу (слэширование). Например,
здесь требует обработки слово John's.
include('adodb.inc.php'); # загружаем бибилиотеку ADOdb
$conn = &ADONewConnection('access'); # создаем соединение
$conn->PConnect('northwind'); # соединяемся с MS-Access, northwind dsn
$shipto = $conn->qstr("John's Old Shoppe");
if ($conn->Execute($sql) === false) {
print 'error inserting: '.$conn->ErrorMsg().'<BR>';
}
В данном примере вы видите расширенные возможности даты, а также
возможности по слэшированию строк в ADODB. Unix тайм штамп (который
является большим целым числом), соответственно, сформатирован в формат
Access функцией DBDate(), а также были расставлены правельные эскейп
последовательности для записи 'John's Old Shope' в базу.
Незабывайте обрабатывать ошибки функции Execute(). Она возвратит FALSE
в случае ошибки. Текстовое сообщение о последней ошибке может быть
показано функцией ErrorMsg(). Внимание: php_track_errors должна быть
включена, чтобы иметь возможность записать сообщение об ошибке.
Пример 4: Отладка
include('adodb.inc.php'); # загружаем библиотеку ADOdb
$conn = &ADONewConnection('access'); # создаем соединение
$conn->PConnect('northwind'); # соединяемся с MS-Access, northwind dsn
$shipto = $conn->qstr("John's Old Shoppe");
$sql = "insert into orders (customerID,EmployeeID,OrderDate,ShipName) ";
$sql .= "values ('ANATR',2,".$conn->FormatDate(time()).",$shipto)";
$conn->debug = true;
if ($conn->Execute($sql) === false) print 'error inserting';
В вышеприведенном примере мы включили отладку, установив debug = true.
Это покажет вам SQL запрос перед тем, как его выполнить, а также
покажет сообщение об ошибке (в случае ее возникновения). При отладке
нет необходимости вызывать функцию ErrorMsg(). Для того, чтобы вывести
на экран результат запроса смотрите пример использования функции
rs2html.
Также прочитайте раздел Ручная обработка ошибок.
Пример 5: MySql и меню
Соединяемся с базой MySql agora, генерируем <select> на основе SQL
запроса, где заголовок <option> - это первая колонка, а значение,
содержащее строку для обращения к серверу, - вторая.
include('adodb.inc.php'); # загружаем библиотеку ADOdb
$conn = &ADONewConnection('mysql'); # создаем соединение
$conn->PConnect('localhost','userid','','agora');# соединяемся с MySQL, agora db
$sql = 'select CustomerName, CustomerID from customers';
$rs = $conn->Execute($sql);
print $rs->GetMenu('GetCust','Mary Rosli');
Здесь мы определяем меню по имени GetCust, и где опция Mary Rosli
является выбранной. Смотрите GetMenu(). Также в нашем арсенале есть
функции, которые возвращают результат в виде массива: GetArray(), и в
виде ассоциированного массива: GetAssoc().
Пример 6: Подключение сразу к двум базам данных
include('adodb.inc.php'); # lзагружаем библиотеку ADOdb
$conn1 = &ADONewConnection('mysql'); # создаем соединение
$conn2 = &ADONewConnection('oracle'); # создаем соединение
Начиная с версии ADODB 4.56 поддерживается функция AutoExecute(),
которая упрощает процедуры, выполняемые функциями-преобразователями
GetInsertSQL() и GetUpdateSQL(). Например INSERT может быть выполнен
следующим образом:
$record["firstname"] = "Caroline";
$record["lastname"] = "Smith"; # меняем фамилию Керолайн со Миранда на Смит
$insertSQL = $conn->AutoExecute($rs, $record, 'UPDATE', 'WHERE id = 1');
Остальная часть данного описания устарела
ADODB 1.31 и более поздние версии поддерживают 2 новые функции:
GetUpdateSQL() и GetInsertSQL(). Это позволит вам исполнять 'SELECT *
FROM tablequery WHERE...', делать копию $rs->fields, изменить поля, и,
затем, составить SQL запрос для автоматической вставки или обновления
записи.
Мы покажем вам, каким образом эти функции могут использоваться для
доступа к таблице со следующими полями: ID, FirstName, LastName,
Created.
Прежде, чем вы можете воспользоваться данными функциями, вам
необходимо инициализировать рекордсет, произведя выборку из таблицы.
Идея принадлежит Jonathan Younger jyounger#unilab.com. Начиная с
версии ADODB 2.42 вы можете передавать название таблицы вместо
рекордсет в функцию GetInsertSQL(), и это позволит сгенерировать SQL
запрос для этой таблицы.
#==============================================
# ПРИМЕР GetUpdateSQL() и GetInsertSQL()
#==============================================
include('adodb.inc.php');
include('tohtml.inc.php');
#==========================
# Этот код проверяет вставляемые данные
$sql = "SELECT * FROM ADOXYZ WHERE id = -1";
# Запрашиваем из базы пустой результат
$conn = &ADONewConnection("mysql"); # создаем соединение
$conn->debug=1;
$conn->PConnect("localhost", "admin", "", "test"); # соединяемся с MySQL, testdb
$rs = $conn->Execute($sql); # Выполняем запрос и получаем пустой результат
$record = array(); # Инициализируем массив с данными для вставки
# Устанавливаем значения для колонок
# Обратите внимание, названия колонок регистрозависимы
$record["firstname"] = "Bob";
$record["lastNamE"] = "Smith";
$record["creaTed"] = time();
# Передаем пустой рекордсет и новые данные для вставки
# в функцию GetInsertSQL. Функция обрабатывает данные и возвращает
# полностью сформатированный SQL запрос для вставки.
$insertSQL = $conn->GetInsertSQL($rs, $record);
$conn->Execute($insertSQL); # Вставляем запись в базу данных
#==========================
# Этот код проверяет данные для обновления
$sql = "SELECT * FROM ADOXYZ WHERE id = 1";
# Запрашиваем обновляемые данные
$record = array(); # Инициализируем массив с данными для обновления
# Устанавливаем значения колонок
# Обратите внимание, названия колонок регистрозависимы
$record["firstname"] = "Caroline";
$record["LasTnAme"] = "Smith"; # Меняем фамилию Кэролайн с Миранды на Смит
# Передаем данные, подлежащие обновлению, и новые данные
# в функцию GetUpdateSQL. Функция обрабатывает данные и возвращает
# полностью сформатированный SQL запрос для обновления с корректным параметромWHERE.
# Если данных для изменения нет - функция вернет пустую строку.
$updateSQL = $conn->GetUpdateSQL($rs, $record);
$conn->Execute($updateSQL); # Обновляем запись в базе данных
$conn->Close();
Пример 8: Организация постраничного вывода
Следующий код показывает как организовать простейший постраничный
вывод.
$pager = new ADODB_Pager($db,$sql);
$pager->Render($rows_per_page=5);
В результате вы увидите что-то похожее на это:
ID First Name Last Name Date Created
36 Alan Turing Sat 06, Oct 2001
37 Serena Williams Sat 06, Oct 2001
38 Yat Sun Sun Sat 06, Oct 2001
39 Wai Hun See Sat 06, Oct 2001
40 Steven Oey Sat 06, Oct 2001
Page 8/10
Количество рядов для вывода контролируется функцией Render(). Если вы
не укажите никакого значения - по умолчанию будет выведено 10 записей.
Вы можете изменять названия колонок изменяя свой SQL запрос
(поддерживается в большинстве баз данных):
$sql = 'select id as "ID", firstname as "First Name",
lastname as "Last Name", created as "Date Created"
from adoxyz';
Вышеприведенный пример вы можете найти в примере
adodb/tests/testpaging.php, включенном в пакет установки. Класс
ADODB_Pager может быть адаптирован программистом для вывода вместо
линков картинок, а белый фон - более подходящим цветом.
Также вы можете настроить показ html при помощи
$pager->htmlSpecialChars = false.
Часть кода, приведенного здесь, выла написана Ivan Oliva и Cornel G.
Пример 9: Экспорт данных в CVS или с разделением табуляцией
В вашем распоряжение есть несколько вспомогательных функций, которые
помогут вам экспортировать данные в CVS или в файл с разделителями в
виде табуляции:
$rs->MoveFirst(); # Замечание: некоторые базы данных не поддерживают MoveFirst
print rs2tab($rs,false); # возвращает строку, разделитель - табуляция
# false == подавляет название полей на первой линии
print '<hr>';
$rs->MoveFirst();
rs2tabout($rs); # выводит непосредственно на stdout (есть также функция rs2csvout)
print "</pre>";
$rs->MoveFirst();
$fp = fopen($path, "w");
if ($fp) {
rs2csvfile($rs, $fp); # записываем в файл (есть также функция rs2tabfile)
fclose($fp);
}
Перевод каретки или переход на новую линию заменены на пробелы.
Названия колонок будут записаны самой первой линией. Строка будет
содержать текст взятый в двойные кавычки с разделителями. Двойные
кавычки будут взяты в двойные кавычки еще раз. Это необходимо, чтобы
файл нормально импортировался в Exel.
Все, описанные выше, функции берут в качестве дополнительного
параметра $addtitles, который по умолчанию выставлен в TRUE. Если его
установить в FALSE - первая линия не будет содержать названия колонок.
Пример 10: Recordset фильтры
Иногда может потребоваться перед использованием сделать преобразование
всех рядов в recordset. Для примера мы преобразуем все текстовые
данные в верхний регистр:
$rs = $db->Execute('select ... from table');
$rs = RSFilter($rs,'do_ucwords');
Функция RSFilter принимает 2 параметра: recordset и название функции
фильтра. Возвращает обработанный recordset с указателем на первом
элементе. Функция фильтра принимает 2 параметра: текущий ряд как
массив и объект recordset. Для будущей совместимости вы не должны
использовать оригинальный объект recordset.
Пример 11: Умные транзакции
Старый способ сделать транзакцию требовал, чтобы вы использовали:
$conn->BeginTrans();
$ok = $conn->Execute($sql);
if ($ok) $ok = $conn->Execute($sql2);
if (!$ok) $conn->RollbackTrans();
else $conn->CommitTrans();
Для большинства проектов этот способ очень сложен, потому что вы
должны отслеживать статус ошибки. Умные транзакции намного проще. Вы
запускаете умную транзакцию функцией StartTrans():
CompleteTrans() обнаруживает возникшие SQL ошибки и делает обратную
перемотку или Commit (подтверждение). Вы также можете вызвать обратную
перемотку, даже если никакой ошибки не произошло используя функцию
FailTrans(). Обратите внимание, что обратная перемотка была сделана в
CompleteTrans(), то в FailTrans() она сделана не будет.
$conn->StartTrans();
$conn->Execute($sql);
if (!CheckRecords()) $conn->FailTrans();
$conn->Execute($Sql2);
$conn->CompleteTrans();
Вы также можете проверить, была ли в процессе транзакции ошибка. Для
этого воспользуйтесь функцией HasFailedTrans(). Она возвратит TRUE,
если вызывалась функция FailTrans() или была ошибка при выполнении SQL
запроса. Убедитесь, что вы вызываете функцию HasFailedTrans() перед
CompleteTrans(), потому что она выдает результат только между
StartTrans/CompleteTrans().
И, наконец, StartTrans/CompleteTrans могут быть вложенными и только
самый удаленный блок выполнен. Функции
BeginTrans/CommitTrans/RollbackTrans, напротив, НЕ МОГУТ быть
вложенными.
Обратите внимания, точки сохранения (savepoints) на данный момент
не поддерживаются.
ADODB - русская документация (часть 3)
(c) 2002-2003 John Lim (jlim#natsoft.com)
(c) 2005 Feskov Kuzma (kuzma#russofile.ru)
Это программное обеспечение распространяется под двумя лицензиями:
BSD-style и LGPL. Это означает, что вы можете использовать его в
компилируемых и коммерческих продуктах.
Содержание
* Рекомендации по созданию переносимого кода
* SELECT
* Способы выдачи результата
* Подсчет количества возвращаемых результатов
* Locking (блокирование, захват)
* Outer Joins (Внешнее присоединение)
* INSERT
* Binding (обвязка)
* Переносимый нативный SQL
Рекомендации по созданию переносимого кода
Если вы создаете приложение, которое может быть использовано в
множестве операционных системах, то вам необходимо распланировать
поддержку различных баз данных. Эта статья опирается на опыт работы со
множеством баз данных в том числе и на компьютере Макинтош. В
настоящее время я использую такие базы данных как: Oracle, FoxPro,
Access, MS SQL Server и MySQL. Хотя большинство советов относится в
пользователям SQL на Perl, Python и др. языках программирования, я
сосредоточусь на использовании PHP и на том, какую помощь предлагает
нам ADODB.
Большинство баз данных являются закрытыми. Самый лучший или быстрый
способ сделать что-то - это использовать патентованные (платные)
расширения SQL. Все это чрезвычайно затрудняет написание переносимого
SQL, который бы хорошо работал при любых условиях. Когда ANSI комитет
собрался в 1984 году, чтобы стандартизировать SQL, большинство
производителей баз данных имели настолько различные способы обработки
данных, что они смогли договориться только об основных функциональных
возможностях SQL. Множество важных определений небыло
стандартизировано. И даже после принятия ANSI-92 SQL, который
стандартизировал гораздо больше, мы все еще должны осуществлять
переносимость на уровне кода.
SELECT
Конструкция SELECT была стандартизована лучше других. Почти каждая
база данных поддерживает следующее:
SELECT [cols] FROM [tables]
[WHERE conditions]
[GROUP BY cols]
[HAVING conditions]
[ORDER BY cols]
Но много полезных возможностей можно реализовать только через
патентованные расширения. Для примера, используя SQL выведем только
первые 10 записей:
|База данных SQL синтаксис
DB2 select * from table fetch first 10 rows only
Informix select first 10 * from table
Microsoft SQL select top 10 * from table
MySQL,PostgreSQL select * from table limit 10
Oracle 8i select * from (select * from table) where rownum <= 10
Эта возможности при получении данных настолько полезна, что в ADODB у
нас есть функция SelectLimit(). Эта функция позволяет вам скрывать
детали формирования запроса в пределах функции, которая напишет запрос
за вас.
$connection->SelectLimit('select * from table', 10);
Способы выдачи результата
PHP позволяет вам получать данные SQL запросов в виде массива. Вы
можете выбрать, каким образом массив будет проиндексирован: названием
поля или числом. Однако разные драйверы баз данных противоречивы в
способах индексации. ADODB позволяет вам четко определить способ
индексации. Нужный вам формат вы можете определить в переменной
$ADODB_FETCH_MODE указав ей в виде значения любую из констант:
ADODB_FETCH_NUM (для числовой индексации), или ADODB_FETCH_ASSOC (для
индексации по названию полей).
Значение поумолчанию определяется ADODB в зависимости от базы данных.
Для точного определения - используйте описанные выше значения.
ADODB_FETCH_NUM - для более быстрой работы, ADODB_FETCH_ASSOC - для
удобства.
Подсчет количества возвращаемых результатов
Еще одной проблемой является то, что некоторые базы данных не
возвращают колличество строк в ответе на запрос SELECT. Это вызвано
тем, что некоторые высокоскоростные базы данных начинают выдавать
результаты еще до того, как будут выбраны все ряды.
В ADODB, функция RecordCount() возвращает число выбранных данных, или
она будет эмулировать это число путем буферизации данных и их
<<ручному>> пересчету, после того, как все запрошенные данные будут
получены. Вы можете отключить эмуляцию по соображениям скорости при
запросе большого количества результатов. Для этого вам необходимо
задать значение глобальной переменной $ADODB_COUNTRECS = false. Эта
переменная проверяется всегда, когда вы запускаете запрос, так что вы
можете выбирать, когда вам нужно посчитать количество возвращаемых
результатов, а когда нет.
Даже если вы установили $ADODB_COUNTRECS = false, у вас есть функция
PO_RecordCount(). Эта функция вернет вам количество строк, а в случае,
если эта информация будет не доступна, возвратит вам результат запроса
SELECET COUNT(*):
$rs = $db->Execute("select * from table where state=$state");
$numrows = $rs->PO_RecordCount('table', "state=$state");
Locking (блокирование, захват)
При использовании SELECT обычно требуется заблокировать на время
выборки данные. Ряд баз данных, например, Oracle, Interbase,
PostgreSQL и MySQL с InnoDB не требуют блокирования, потому что
используют versionning (версионность), чтобы показать данные на данный
конкретный момент времени.
На данный момент я рекомендую инкапсулировать блокировку при помощи
функции RowLock($table, $where).
if ($ok) $connection->CommitTrans( );
else $connection->RollbackTrans( );
Outer Joins (Внешнее присоединение)
Не все базы данных поддерживают внешнее присоединение. К тому же,
синтаксис у разных баз данных сильно отличается. Один из переносимых
способов (возможно, медленных) делать внешние присоединения - это
использование UNION.
Например, в ANSI-92 внешнее присоединение слева между двумя таблицами
может выглядеть так:
SELECT t1.col1, t1.col2, t2.cola
FROM t1 LEFT JOIN t2 ON t1.col = t2.col
Это можно эмулировать следующим образом:
SELECT t1.col1, t1.col2, t2.cola FROM t1, t2
WHERE t1.col = t2.col
UNION ALL
SELECT col1, col2, null FROM t1
WHERE t1.col not in (select distinct col from t2)
С версии 2.13 в ADODB есть некоторые функции для помощи в составлении
таких запросов. Эти функции все еще не полны и не совершенны и часто
зависят от версии используемой базы данных. Но они могут быть полезны
как общее руководство:
$conn->leftOuter: возвращает оператор для внешнего присоединения слева
(например, *=), или FALSE, если составление оператора невозможно.
$conn->rightOuter: возвращает оператор для внешнего присоединения
справа (например, =*), или FALSE, если составление оператора
невозможно.
$conn->ansiOuter: булевая переменная. TRUE - если ваша база данных
поддерживает ANSI-92, FALSE - если вы не уверены или не знаете об
этом.
INSERT
Когда вы заносите в таблицу запись, то необходимо создать уникальный
ID записи. Существует 2 общих способа: 1) auto-increment колонки, 2)
последовательности.
Auto-increment колонки поддерживаются MySQL, Sybase и Microsoft Access
и SQL Server. Однако большинство других баз не поддерживают такую
возможность. Отсюда видно, что для создания переносимого кода у вас не
такой большой выбор, а именно - использовать последовательности.
Последовательности - это специальные функции, которые возвращают
уникальное число каждый раз, когда вы к ним обращаетесь. Эти числа
вполне подходят для использования в качестве уникальных ключей. В
ADODB мы используем функцию GenId(). В качестве параметра она
принимает название последовательности. Различные таблицы могут иметь
разные последовательности.
Для баз данных, не поддерживающих последовательности, ADODB делает
эмуляцию, создавая таблицы, для каждой последовательности.
Binding (обвязка)
Обвязка переменный в SQL запросе - это еще одна хитра особенность.
Обвязка полезна, поскольку позволяет перекомпилировать SQL запрос. При
многократной вставке однотипных данных в цикле, обвязка может
сохранить до 50% (или больше) ресурсов и времени. Однако, многие базы
данных, например Access и MySql не поддерживают нативно обвязку, а
потому приходится делать некоторую надстройку для эмуляции обвязки.
Кроме того, отдельные базы данных (особенно Oracle!), делают обвязку
подругому. Я рекомендую делать обвязку только в том случае, если ваши
запросы к базе данных очень медленные. Но удостоверьтесь, что ваша
база данных поддерживает обвязку, например, Oracle.
ADODB поддерживает переносимые Portable/Execute:
$stmt = $db->Prepare('select * from customers where custid=? and state=?');
$rs = $db->Execute($stmt, array($id,'New York'));
Oracle использует именованные placeholders (не <<?>>). Для создания
переносимого кода мы имеем функцию Param(), которая производит
правильный placeholder (с версии ADODB 3.92):
$sql = 'insert into table (col1,col2) values ('.$DB->Param('a').','.$DB->Param('b').')';
# генерирует 'insert into table (col1,col2) values (?,?)'
# или 'insert into table (col1,col2) values (:a,'
$stmt = $DB->Prepare($sql);
$stmt = $DB->Execute($stmt,array('one','two'));
Переносимый нативный SQL
ADODB обеспечивает следующие функции для генерации частей SQL запроса
для встраивания затем их в основной запрос (некоторые доступны только
с версии 3.92):
DBDate($date)
Берет UNIX timestamp или дату в формате ISO, и
конвертирует ее в строку, пригодную для запросов INSERT/UPDATE
DBTimeStamp($date)
Берет UNIX timestamp или дату в формате ISO, и
конвертирует ее в строку, пригодную для запросов INSERT/UPDATE
SQLDate($date, $fmt)
Переносимо форматирует дату по маске из $fmt для
использвания ее в SELECT запросе
OffsetDate($date, $ndays)
Переносимо генерирует дату ($date) с
добавлением дней ($ndays).
Concat($s1, $s2, ...)
Переносимо объединяет строки. Как альтернатива,
для mssql, используйте mssqlpo драйвер, который принимеет || оператор.
IfNull($fld, $replaceNull)
Возвращает строку иквивалентную MySQL IFNULL или Oracle NVL.
Param($name)
Генерирует placeholders, используя ? или именованные соглашения.
$db->sysDate
Формирует SQL запрос, который возвращает системную дату.
$db->sysTimeStamp
Формирует запрос, который возвращает тайм штамп (date+time).
'
Vova
