204 lines
9.8 KiB
HTML
204 lines
9.8 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>Sharding — Doctrine MongoDB ODM 1.1.5 documentation</title>
|
||
|
|
<link rel="stylesheet" href="../_static/bootstrap/css/bootstrap.min.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/layout.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="../_static/configurationblock.css" type="text/css" />
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: '../',
|
||
|
|
VERSION: '1.1.5',
|
||
|
|
COLLAPSE_MODINDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/configurationblock.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/configurationblock.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||
|
|
<script type="text/javascript" src="../_static/configurationblock.js"></script>
|
||
|
|
<script src="../_static/bootstrap/js/bootstrap.min.js"></script>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
<!--
|
||
|
|
$(document).ready(function() {
|
||
|
|
$("#versions").change(function() {
|
||
|
|
var docsUrl = $(this).val();
|
||
|
|
window.location.href = docsUrl;
|
||
|
|
});
|
||
|
|
});
|
||
|
|
-->
|
||
|
|
</script>
|
||
|
|
<link rel="shortcut icon" href="../_static/doctrine.ico"/>
|
||
|
|
<link rel="search" title="Search" href="../search.html" />
|
||
|
|
<link rel="top" title="Doctrine MongoDB ODM 1.1.5 documentation" href="../index.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="wrapper">
|
||
|
|
<div id="header">
|
||
|
|
<h1 id="h1title"></h1>
|
||
|
|
<div id="logo">
|
||
|
|
<a href="http://www.doctrine-project.org/">Doctrine - PHP Database Libraries</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="nav" class="cls">
|
||
|
|
<div class="tl cls">
|
||
|
|
<ul>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/">Home</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/about.html">About</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/projects.html">Projects</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/contribute.html">Contribute</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/community.html">Community</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/archive.html">Blog</a></li>
|
||
|
|
<li><a target="_top" href="http://www.doctrine-project.org/jira">Development</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="content" class="cls">
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="/">Doctrine Homepage</a> »</li>
|
||
|
|
<li><a href="../index.html">Doctrine MongoDB ODM 1.1.5 documentation</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
|
||
|
|
<div class="body" >
|
||
|
|
|
||
|
|
<div class="section" id="sharding">
|
||
|
|
<span id="id1"></span><h1>Sharding<a class="headerlink" href="#sharding" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<p>MongoDB allows you to horizontally scale your database. In order to enable this,
|
||
|
|
Doctrine MongoDB ODM needs to know about your sharding setup. For basic information
|
||
|
|
about sharding, please refer to the <a class="reference external" href="https://docs.mongodb.com/manual/sharding/">MongoDB docs</a>.</p>
|
||
|
|
<p>Once you have a <a class="reference external" href="https://docs.mongodb.com/manual/core/sharded-cluster-architectures-production/">sharded cluster</a>,
|
||
|
|
you can enable sharding for a document. You can do this by defining a shard key in
|
||
|
|
the document:</p>
|
||
|
|
<div class="configuration-block">
|
||
|
|
<ul class="simple">
|
||
|
|
<li><em>PHP</em><div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
|
||
|
|
|
||
|
|
<span class="sd">/**</span>
|
||
|
|
<span class="sd"> * @Document</span>
|
||
|
|
<span class="sd"> * @ShardKey(keys={"username"="asc"})</span>
|
||
|
|
<span class="sd"> */</span>
|
||
|
|
<span class="k">class</span> <span class="nc">User</span>
|
||
|
|
<span class="p">{</span>
|
||
|
|
<span class="sd">/** @Id */</span>
|
||
|
|
<span class="k">public</span> <span class="nv">$id</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Field(type="int") */</span>
|
||
|
|
<span class="k">public</span> <span class="nv">$accountId</span><span class="p">;</span>
|
||
|
|
|
||
|
|
<span class="sd">/** @Field(type="string") */</span>
|
||
|
|
<span class="k">public</span> <span class="nv">$username</span><span class="p">;</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li><em>XML</em><div class="highlight-xml"><div class="highlight"><pre><span class="nt"><doctrine-mongo-mapping</span> <span class="na">xmlns=</span><span class="s">"http://doctrine-project.org/schemas/orm/doctrine-mongo-mapping"</span>
|
||
|
|
<span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span>
|
||
|
|
<span class="na">xsi:schemaLocation=</span><span class="s">"http://doctrine-project.org/schemas/orm/doctrine-mongo-mapping</span>
|
||
|
|
<span class="s"> http://doctrine-project.org/schemas/orm/doctrine-mongo-mapping.xsd"</span><span class="nt">></span>
|
||
|
|
|
||
|
|
<span class="nt"><document</span> <span class="na">name=</span><span class="s">"Documents\User"</span><span class="nt">></span>
|
||
|
|
<span class="nt"><shard-key></span>
|
||
|
|
<span class="nt"><key</span> <span class="na">name=</span><span class="s">"username"</span> <span class="na">order=</span><span class="s">"asc"</span><span class="nt">/></span>
|
||
|
|
<span class="nt"></shard-key></span>
|
||
|
|
<span class="nt"></document></span>
|
||
|
|
<span class="nt"></doctrine-mongo-mapping></span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li><em>YAML</em><div class="highlight-yaml"><div class="highlight"><pre><span class="l l-Scalar l-Scalar-Plain">Documents\User</span><span class="p p-Indicator">:</span>
|
||
|
|
<span class="l l-Scalar l-Scalar-Plain">shardKey</span><span class="p p-Indicator">:</span>
|
||
|
|
<span class="l l-Scalar l-Scalar-Plain">keys</span><span class="p p-Indicator">:</span>
|
||
|
|
<span class="l l-Scalar l-Scalar-Plain">username</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">asc</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">When a shard key is defined for a document, Doctrine MongoDB ODM will no
|
||
|
|
longer persist changes to the shard key as these fields become immutable in
|
||
|
|
a sharded setup.</p>
|
||
|
|
</div>
|
||
|
|
<p>Once you've defined a shard key you need to enable sharding for the collection
|
||
|
|
where the document will be stored. To do this, use the <code class="docutils literal"><span class="pre">odm:schema:shard</span></code>
|
||
|
|
command.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">For performance reasons, sharding is not enabled during the
|
||
|
|
<code class="docutils literal"><span class="pre">odm:schema:create</span></code> and <code class="docutils literal"><span class="pre">odm:schema:update</span></code> commmands.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
|
||
|
|
<div id="searchbox" style="">
|
||
|
|
<h3>Search</h3>
|
||
|
|
<form class="search" action="http://readthedocs.org/search/project/" method="get">
|
||
|
|
<input type="text" name="q" size="18">
|
||
|
|
<input type="submit" value="Go">
|
||
|
|
<input type="hidden" name="selected_facets" value="project:">
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="../_sources/reference/sharding.rst.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2013, Doctrine Project Team.
|
||
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.2.
|
||
|
|
<br/>
|
||
|
|
<a target="_BLANK" href="http://www.servergrove.com"><img src="http://www.doctrine-project.org/_static/servergrove.jpg" /></a> <br/><br/>
|
||
|
|
<form action="https://www.paypal.com/cgi-bin/webscr" method="post">
|
||
|
|
<input type="hidden" name="cmd" value="_s-xclick" />
|
||
|
|
<input type="hidden" name="hosted_button_id" value="BAE2E3XANQ77Y" />
|
||
|
|
<input type="image" src="https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!" />
|
||
|
|
<img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1" />
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="bot-rcnr">
|
||
|
|
<div class="tl"><!-- corner --></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
_uacct = "UA-288343-7";
|
||
|
|
urchinTracker();
|
||
|
|
</script>
|
||
|
|
<a class="githublink" href="http://github.com/doctrine"><img src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" alt="Fork me on GitHub"></a>
|
||
|
|
</body>
|
||
|
|
</html>
|