面向 PHP 开发人员的 CouchDB 基础知识

常用缩略语

{
"Firstname": "Tom"
"Lastname": "Myer"
"Twitter": "@myerman"
"Email": "tom@example.com"
"Skills": ["php","couchdb","xml","json"]
"Work History": ....
}

在 Linux 内安装

sudo apt-get install couchDB
sudo /etc/init.d/couchdb start

sudo port install couchdb

sudo port upgrade couchdb

sudo launchctl load -w /opt/local/Library/LaunchDaemons/org.apache.couchdb.plist

GET

PUT

GET

POST

PUT

DELETE

curl http://127.0.0.1:5984/[/code] 。随后，应该会得到类似于 
{"couchdb":"Welcome","version":"0.10.0"}

的一个响应。这只是为了告诉您 CouchDB 已经启动并运行以及所使用的是何版本。如果您没有看到这个消息，那么就请重新进行安装和配置直至 CouchDB 启动并运行。

现在，尝试列出在 CouchDB 内设置的所有集合。运行 
curl -X GET http://127.0.0.1:5984/_all_dbs[/code] 。

如果 CouchDB 是初次安装，应该会看到响应 
[]

，这意味着没有任何集合或数据库（方括号代表的是一个空的 JavaScript 数组）。请注意在这个 cURL 命令中，使用了 
-X

选项来显式指定一个 
GET

操作。

现在，让我们通过创建一个数据库来解决该问题：

 

curl -X PUT http://127.0.0.1:5984/songs

在运行上述命令后，会得到响应 
{"ok":true}

。现在您知道您可以查看 
ok

属性来确认成功与否。再次运行 
curl -X GET http://127.0.0.1:5984/_all_dbs[/code] ，结果会得到一个非空数组：
["songs"]

。并且，您的 CouchDB 实例内具有这样一个数据库：songs
。

现在尝试创建另一个名为 songs
的数据库。如果您再次运行 
curl -X PUT http://127.0.0.1:5984/songs

，将会获得一个如下所示的错误消息：

 

{"error":"file_exists","reason":"The database could not be created,
the file already exists."}

所以您可以很容易地查看 
error

属性来确认问题发生与否。

创建第二个名为 foobar
的数据库：

 

curl -X PUT http://127.0.0.1:5984/foobar

如果运行 
curl -X GET http://127.0.0.1:5984/_all_dbs[/code] ，结果会获得响应 
["songs","foobar"]

。为了去掉第二个数据库，可以向它传递一个 
DELETE

调用：

 

curl -X DELETE http://127.0.0.1:5984/foobar

运行 
curl -X GET http://127.0.0.1:5984/_all_dbs

表示您已经回至 
["songs"]

。

现在继续，在 songs 数据库内创建一些文档。毋庸置疑，您想要在这个数据库内存储一些歌曲，这些歌曲具有曲名、艺人名称和专辑名称字段。要创建一个文档，遵循如下这个模式：

 

curl -X PUT http://127.0.0.1:5984/songs/*id* -d '{ *json_data* }'

注意到先是调用数据库的名称，随后是 ID（要求 ID 不仅要在这个 CouchDB 实例中惟一，而且还要尽量在所有实例中惟一），再后来是 JSON 数据。

如何获得惟一 ID？可以使用一个 UUID（或一个 GUID）作为惟一
ID，或者也可以创建某种综合了各种小块数据的自然键（比如，歌曲名中用下划线代替空格，再加上时间戳），或者是让 CouchDB 为您创建一个惟一
ID （这个过程很慢）。上述方式都不错，只是不要像在 MySQL 环境内那样使用自动增量的值。

现在，向您的数据库内输入一首歌曲：

 

curl -X PUT http://localhost:5984/songs/whatever_you_like -d /
'{"title":"Whatever You Like", "artist":"T.I.","album":"Paper Trail"}'

{"ok":true,"id":"whatever_you_like","rev":"1-1d915e4c209a2e47e5cf05594f9f951b"}

请注意我对这个惟一 ID
采用了一个十分简单的方式（使用了一个简化了的歌曲名称，用下划线代替了空格）。这种简单的方式对于目前的需要还能满足。幸运的是，在 PHP
内将要使用的包装器会帮助您创建更好的 ID。也请注意我立即收到了一个 “ok” 响应，并且其中的文档 ID 和 
rev

属性还告知了所设置的修订版本。

要查看刚刚添加的这个文档，可以尝试：

 

curl -X GET http://localhost:5984/songs/whatever_you_like 
{"_id":"whatever_you_like","_rev":"1-1d915e4c209a2e47e5cf05594f9f951b",
"title":"Whatever You Like", "artist":"T.I.", "album":"Paper Trail"}

如果您一直在 Futon 内尝试，应该能够单击这个歌曲数据库名并在文档列表内看到一个 
whatever_you_like

项。单击该链接会显示所感兴趣的这个文档的详细信息，如图 2 所示。

图 2. 文档详细信息



您逐渐发觉 — 用 JSON 做出 RESTful 请求后就会有事情发生。

现在，所有这些看上去都很好，但是如果您是一名 PHP 开发人员，可能会疑惑如何将这些综合在一起形成自己熟悉的东西呢。下一节会向您介绍面向 CouchDB 的 PHP 包装器。

使用 PHP

对于下一个步骤，您需要从 Github 下载 PHP-on-Couch（参见 参考资料

）。
将解压缩了的 /lib 文件夹内容放入您的开发区域。在设置好工作区域后，创建一个简单的 PHP 应用程序来与已经设置好的这个 CouchDB
数据库（您的歌曲集）对话。创建一个新文件，然后将其命名为 index.php。并在其内放入清单 2 内的代码。

清单 2. CouchDB 连接设置

<?php
$couch_dsn = "http://localhost:5984/";
$couch_db = "songs";

require_once "./lib/couch.php";
require_once "./lib/couchClient.php";
require_once "./lib/couchDocument.php";

$client = new couchClient($couch_dsn,$couch_db);
?>

上述代码充当的是到 CouchDB 的连接代码并且包含使用此数据库所需的所有相关类。接着列出与数据库相关的全部信息，如清单 3 所示。

清单 3. 获得数据库信息

try {
$info = $client->getDatabaseInfos();
} catch (Exception $e) {
echo "Error:".$e->getMessage()." (errcode=".$e->getCode().")/n";
exit(1);
}
print_r($info);

得到的结果应该类似于清单 4。

清单 4. 数据库信息

stdClass Object
(
[db_name] => songs
[doc_count] => 2
[doc_del_count] => 0
[update_seq] => 2
[purge_seq] => 0
[compact_running] =>
[disk_size] => 8281
[instance_start_time] => 1266082749089965
[disk_format_version] => 4
)

接下来，从歌曲数据库中检索一个文档。清单 5 给出了所需代码。

清单 5. 从数据库中检索一首歌

try {
$doc = $client->getDoc('whatever_you_like');
} catch (Exception $e) {
if ( $e->code() == 404 ) {
echo "Document not found/n";
} else {
echo "Error: ".$e->getMessage()." (errcode=".$e->getCode().")/n";
}
exit(1);
}
print_r($doc);

清单 6 给出了响应。

清单 6. 检索到的歌曲

stdClass Object
(
[_id] => whatever_you_like
[_rev] => 1-1d915e4c209a2e47e5cf05594f9f951b
[title] => Whatever You Like
[artist] => T.I.
[album] => Paper Trail
)

很不错，但是如何对一个文档进行更新呢？可以做的更新有两种：更改现有字段值；添加新字段和新值。对于后者，可以使用箭头表示法（比如 
$doc->new_field

），然后通过 
storeDoc()

保存更改。清单 7 显示了更新一个文档所需的代码。

清单 7. 更新一个文档

$doc->genre = 'hip-hop';
$doc->year = 2008;
try {
$response = $client->storeDoc($doc);
} catch (Exception $e) {
echo "Error: ".$e->getMessage()." (errcode=".$e->getCode().")/n";
exit(1);
}

运行此代码，然后就可以检索这个文档 ID 并获得清单 8 内所示的结果。

清单 8. 更新后的文档

stdClass Object
(
[_id] => whatever_you_like
[_rev] => 2-12513a362693b300928aa45f82faed83
[title] => Whatever You Like
[artist] => T.I.
[album] => Paper Trail
[genre] => hip-hop
[year] => 2008
)

注意到 
_rev

属性已经从之前的 
1-whatever

增加为 
2-whatever

。借此，就可以很容易地判断已经发生了更改。

那么，该如何在数据库内存储一个新文档呢？您可以实例化一个新对象并使用箭头表示法来填充文档内的字段。清单 9 显示了所需代码。

清单 9. 创建一个新文档

$song = new stdClass();
$song->_id = "in_the_meantime";
$song->title = "In the Meantime";
$song->album = "Resident Alien";
$song->artist = "Space Hog";
$song->genre = "Alternative";
$song->year = 1995;

try {
$response = $client->storeDoc($song);
} catch (Exception $e) {
echo "Error: ".$e->getMessage()." (errcode=".$e->getCode().")/n";
exit(1);
}
print_r($response);

结果应该类似清单 10。

清单 10. 创建一个新文档的结果

stdClass Object
(
[ok] => 1
[id] => in_the_meantime
[rev] => 1-d65b03a9fe2f3c8095b08883e7cd97df
)

结束语

至此，您应该具备了开始使用 CouchDB 和 PHP
的足够信息。您也应该能够轻松创建您的基本更新表单并能在日后创建或更新数据库内的现有文档。PHP-on-Couch
包还为您提供了创建和删除数据库以及使用 CouchDB 视图等的其他方法。总之，本文有足够信息可以让您从开始就有一个很好的起点。

参考资料

学习

访问 CouchDB

项目站点。

CouchDB: The Definitive Guide

是 CouchDB 权威指南的一个免费在线版本。

查阅 CouchDB wiki

寻找有关 CouchDB 疑问的答案。

阅读 Installing CouchDB on Windows

获得在 Windows 平台上安装数据库的指导。

访问 Installing CouchDB on Linux/BSD

获得在运行 Linux 或 BSD 的计算机上安装数据库的指导。

参阅 The CouchDB API Reference

了解本文使用的这个 API 的更多信息。

阅读 “探索 CouchDB

” 了解 CouchDB 缘何如此突出。

PHP.net

是面向 PHP 开发人员的中心资源。

查阅 “推荐 PHP 读物列表

”

浏览 developerWorks 上的所有 PHP 内容

。

用 IBM developerWorks 的 PHP 项目资源

提高您的 PHP 技巧。

要收听针对软件开发人员的有趣访谈和讨论，请访问 developerWorks podcasts

。

要将数据库与 PHP 结合使用？查看 Zend Core for IBM

，它是一个无缝的、可以立即使用、易于安装、支持 IBM DB2 V9 的 PHP 开发和生产环境。

My developerWorks

涵盖了大量主题，是一个成功社区的典范。

随时关注 developerWorks 技术活动

和网络广播

。

查阅最近将在全球举办的面向 IBM 开放源码开发人员的研讨会、交易展览、网络广播和其他 活动

。

访问 developerWorks Open source 专区

获得丰富的 how-to 信息、工具和项目更新以及最受欢迎的文章和教程

，帮助您用开放源码技术进行开发，并将它们与 IBM 产品结合使用。

查看免费的 developerWorks 演示中心

观看并了解 IBM 及开源技术和产品功能。

获得产品和技术

从 Github 下载 PHP-on-Couch

库。

使用 IBM 产品评估试用版软件

改进您的下一个开发项目，这些软件可以通过下载获得。

下载 IBM 产品评估试用版软件

或 IBM SOA Sandbox for People

并开始使用来自 DB2®、Lotus®、Rational®、Tivoli® 和 WebSphere® 的应用程序开发工具和中间件产品。

文章来源：http://www.ibm.com/developerworks/cn/opensource/os-php-couchdb/index.html