/
index.html
323 lines (267 loc) · 13.8 KB
/
index.html
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<!DOCTYPE html>
<html lang="ja-JP">
<head>
<meta charset="UTF-8">
<title>Mongoose - デベロッパーズガイド 日本語訳</title>
<link href="./style.css" media="screen" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="wrap">
<div id="side">
<header>
<h1><a href="./index.html">Mongoose - Developers Guide</a></h1>
<h2>Mongoose - デベロッパーズガイド 日本語訳</h2>
</header>
<nav>
<ul>
<li><a href="#api">API</a></li>
<li><a href="./model-definition.html">Model Definition</a></li>
<li><a href="./embedded-documents.html">Embedded Documents</a></li>
<li><a href="./middleware.html">Middleware</a></li>
<li><a href="./defaults.html">Defaults</a></li>
<li><a href="./indexes.html">Indexes</a></li>
<li><a href="./validation.html">Validation</a></li>
<li><a href="./virtuals.html">Virtulas</a></li>
<li><a href="./getters-setters.html">Getters / Setters</a></li>
</ul>
</nav>
<div id="license">
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/2.1/jp/"><img alt="クリエイティブ・コモンズ・ライセンス" style="border-width:0" src="http://i.creativecommons.org/l/by-nc-sa/2.1/jp/80x15.png" /></a>
<p>このページは <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/2.1/jp/">Creative Commons 表示 - 非営利 - 継承 2.1 日本 License</a> にもとづいて公開されています。</p>
</div>
<section>
<h2>このドキュメントについて</h2>
<p>本ドキュメントは、 Node.JS の <a href="http://www.mongodb.org/">MongoDB</a> ORM-like な機能を提供するユーティリティライブラリである
<a href="https://github.com/LearnBoost/mongoose">Mongoose</a> のマニュアルを翻訳したものです。</p>
<p>誤り等ございましたら、 <a href="http://twitter.com/#!/muddydixon">@muddydixon</a> までご連絡ください</p>
<h3>オリジナルコピーライト</h3>
<p>Mongoose by gradebook LearnBoost Labs. Released under the MIT license - Copyright LearnBoost 2011</p>
</section>
</div>
<div id="content-wrap">
<div id="content">
<article>
<h1>Mongoose 1.0</h1>
<section>
<h2>Mongoose とは ?</h2>
<p>Mongoose は非同期環境において機能することを目的とした MongoDB のオブジェクトモデリングツールです。</p>
<p>モデルの定義は簡単です</p>
<pre><code>var Comments = new Schema({
title : String
, body : String
, date : Date
});
var BlogPost = new Schema({
author : ObjectId
, title : String
, body : String
, date : Date
, comments : [Comments]
, meta : {
votes : Number
, favs : Number
}
});
mongoose.model('BlogPost', BlogPost);</code></pre>
</section>
<section>
<h2>インストール</h2>
<p>推奨は素晴らしいNPMを通して行うことです</p>
<pre><code>$ npm install mongoose</code></pre>
<p>それ以外では、リポジトリからチェックしてください</p>
<pre><code>$ git clone git@github.com:LearnBoost/mongoose.git support/mongoose/
// in your code
require.paths.unshift('support/mongoose/lib')</code></pre>
<p>requireしてください</p>
<pre><code>require('mongoose')</code></pre>
</section>
<section>
<h2>MongoDB と接続する</h2>
<p>まず、コネクションを定義します。もし、アプリがひとつのデータベースだけを利用するのであれば、 <code>mongose.connect</code> と書くべきです。
コネクションを追加する必要があるのであれば、 <code>mongoose.createConnection</code> を使います。</p>
<p><code>connect</code> and <code>createConnection</code> のどちらも、 <code>mongodb://</code> URI および <code>host, database, port</code> を取ります。</p>
<pre><code>var mongoose = require('mongoose');
mongoose.connect('mongodb://localhost/my_database');</code></pre>
<p>一度接続すると、 <code>Connection</code> インスタンスで <code>open</code> が発火されます。
もし、 <code>mongoose.connect</code> を利用しているのであれば、 <code>Connection</code> は <code>mongoose.connection</code> です。
そうでなければ、 <code>mongoose.createConnection</code> の戻り値は <code>Connection</code> になります。</p>
<p><strong>Important!</strong> Mongoose はすべてのコマンドを、データベースに接続されるまでバッファします。
これは、モデルを定義したり、クエリを発行したりを行うことを MongoDB に接続するまで待つ必要がないことを意味します。</p>
</section>
<section>
<h2>モデルの定義</h2>
<p>モデルは <code>Schema</code> インタフェイスを通して定義されます。</p>
<pre><code>var Schema = mongoose.Schema
, ObjectId = Schema.ObjectId;
var BlogPost = new Schema({
author : ObjectId
, title : String
, body : String
, date : Date
});</code></pre>
<p>document の定義や保存しようとしているデータのタイプはおいておいて、 Schema は以下の定義を行います。</p>
<ul>
<li>Validators (async and sync)</li>
<li>Defaults</li>
<li>Getters</li>
<li>Setters</li>
<li>Indexes</li>
<li>Middleware</li>
<li>Methods definition</li>
<li>Statics definition</li>
<li>Plugins</li>
</ul>
<p>下記に、これらの特徴を例示します。</p>
<pre><code>var Comment = new Schema({
name : { type: String, default: 'hahaha' }
, age : { type: Number, min: 18, index: true }
, bio : { type: String, match: /[a-z]/ }
, date : { type: Date, default: Date.now }
});
// a setter
Comment.path('name').set(function (v) {
return v.capitalize();
});
// middleware
Comment.pre('save', function (next) {
notify(this.get('email'));
next();
});</code></pre>
<p>機能的に利用可能な (ほとんど) すべての例として <code>examples/schema.js</code> の例を見てください。</p>
</section>
<section>
<h2>モデルへのアクセス</h2>
<p><code>mongoose.model('ModelName', mySchema)</code> を通して一度モデルを定義すると、同じ関数を通してアクセスすることができます。</p>
<pre><code>var myModel = mongoose.model('ModelName');</code></pre>
<p>インスタンス化して、保存します。</p>
<pre><code>var instance = new myModel();
instance.my.key = 'hello';
instance.save(function (err) {
//
});</code></pre>
<p>または、同じ collection から document を検索することができます。</p>
<pre><code>myModel.find({}, function (err, docs) {
// docs.forEach
});</code></pre>
<p>また、 <code>findOne</code> 、 <code>findById</code> 、 <code>update</code> なども利用可能です。
より詳細は API docs をチェックして下さい。</p>
</section>
<section>
<h2>Embedded Documents</h2>
<p>最初のスニペットの中で、以下のような Schema で key を定義します。</p>
<pre><code>comments: [Comments]</code></pre>
<p> <code>Comments</code> は、作成済みの <code>Schema</code> です。
Embedded document を利用するには下記のようにします。</p>
<pre><code>// retrieve my model
var BlogPost = mongoose.model('BlogPost');
// create a blog post
var post = new BlogPost();
// create a comment
post.comments.push({ title: 'My comment' });
post.save(function (err) {
if (!err) console.log('Success!');
});</code></pre>
<p>削除も同じようにして行います。</p>
<pre><code>BlogPost.findById(myId, function (err, post) {
if (!err) {
post.comments[0].remove();
post.save(function (err) {
// do something
});
}
});</code></pre>
<p>Embedded document はモデルと同じ Default や validator 、 middleware などの特徴を利用することができます。
error が生じたときには、 <code>save()</code> の error callback にバブリングするので、 error の扱いがとても簡単です。</p>
<p>Mongoose は配列の中の embedded document とインスタンス化した瞬間から <em>atomically</em> にやり取りします。</p>
</section>
<section>
<h2>Middleware</h2>
<p>Middleware は、 Mongoose 1.0 における最も興奮する特徴の一つです。
Middleware 入れ子のコールバックの苦痛を取り払ってくれます。</p>
<p>Middleware は Schema レベルで定義され、<code>init</code> (MongoDB のデータが document として初期化されたとき)、
<code>save</code> (document または embedded document が保存されたとき) のメソッドに対して適用されます。</p>
<p>2つのタイプの middleware があり、定義した関数のシグニチャで決定されます (例えば、関数が受容するパラメタなどです)</p>
<ul>
<li><h2>Serial</h2>
<p>Serial middleware は次のように定義します。</p>
<pre><code>.pre(method, function (next) {
// ...
})</code></pre>
<p>それぞれの middleware が <code>next</code> を呼ぶときに、次々と実行されます。</p>
</li>
<li><h2>Parallel</h2>
<p>Parallel middleware はより肌理の細かいフローコントロールを提供し、次のように定義します。</p>
<pre><code>.pre(method, function (next, done) {
// ...
})</code></pre>
<p>Parallel middleware は、即座に <code>next()</code> を実行しますが、最後の引数はすべての parallel middleware が done() を呼んだ時に呼び出されます。</p>
</li>
</ul>
<h3>Error 制御</h3>
<p>middleware が <code>Error</code> インスタンスを伴って <code>next</code> や <code>done</code> を呼び出したときには、フローは中断され、 error は (Model の)引数で渡された関数に渡されます。</p>
<p>例：</p>
<pre><code>schema.pre('save', function (next) {
// something goes wrong
next(new Error('something went wrong'));
});
// later...
myModel.save(function (err) {
// err can come from a middleware
});</code></pre>
</section>
<section>
<h2>API ドキュメント</h2>
<p> <a href="http://github.com/visionmedia/dox">Dox</a> で生成された API docs を <a href="http://mongoosejs.com">http://mongoosejs.com</a> で見ることができます。</p>
</section>
<section>
<h2>Getting support</h2>
<p>Google Groups の <a href="http://groups.google.com/group/mongoose-orm/boxsubscribe">メーリングリスト</a> を購読してください。</p>
</section>
<section>
<h2>Contributing to Mongoose</h2>
<h3>Cloning the repository</h3>
<p>Make a fork of <code>mongoose</code>, then clone it in your computer. The <code>master</code> branch
contains the current stable release, and the <code>develop</code> branch the next upcoming
major release.</p>
<p>If <code>master</code> is at <code>1.0</code>, <code>develop</code> will contain the upcoming <code>1.1</code> (or <code>2.0</code> if
the <code>1</code> branch is nearing its completion).</p>
<h3>Guidelines</h3>
<ul><li>Please write inline documentation for new methods or class members.</li><li>Please write tests and make sure your tests pass.</li><li>Before starting to write code, look for existing tickets or create one for
your specifc issue (unless you're addressing something that's clearly broken).
That way you avoid working on something that might not be of interest or that
has been addressed already in a different branch.</li></ul>
</section>
<section>
<h2>Credits</h2>
<ul>
<li>Guillermo Rauch - guillermo@learnboost.com - <a href="http://github.com/guille">Guille</a></li>
<li>Nathan White - <a href="http://github.com/nw/">nw</a></li>
<li>Brian Noguchi - <a href="https://github.com/bnoguchi">bnoguchi</a></li>
</ul>
</section>
<section>
<h2>License</h2>
<p>Copyright (c) 2010 LearnBoost &lt;dev@learnboost.com&gt;</p>
<p>Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:</p>
<p>The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
</section>
</article>
</div>
</div>
</div>
</body>
</html>