Skip to content

Commit

Permalink
build based on d6fb826
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 17, 2023
1 parent 5099f8b commit 76e0686
Show file tree
Hide file tree
Showing 10 changed files with 46 additions and 46 deletions.
74 changes: 37 additions & 37 deletions dev/api/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/authentication/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
roles = Mongoc.BSON("""[ { "role" : "userAdminAnyDatabase", "db" : "admin" }, "readWriteAnyDatabase" ]""")
client = Mongoc.Client()
Mongoc.add_user(client["admin"], "myUserAdmin", "abc123", roles)
Mongoc.destroy!(client) # or exit julia session</code></pre><h4 id=".-Re-start-the-MongoDB-instance-with-access-control"><a class="docs-heading-anchor" href="#.-Re-start-the-MongoDB-instance-with-access-control">3. Re-start the MongoDB instance with access control</a><a id=".-Re-start-the-MongoDB-instance-with-access-control-1"></a><a class="docs-heading-anchor-permalink" href="#.-Re-start-the-MongoDB-instance-with-access-control" title="Permalink"></a></h4><p>Kill the previous process running <code>mongod</code> and then start server with auth option.</p><pre><code class="language-shell hljs">$ mongod --auth --dbpath ./db</code></pre><h3 id="Connect-and-authenticate"><a class="docs-heading-anchor" href="#Connect-and-authenticate">Connect and authenticate</a><a id="Connect-and-authenticate-1"></a><a class="docs-heading-anchor-permalink" href="#Connect-and-authenticate" title="Permalink"></a></h3><p>Pass the user and password in the URI, as described in <a href="http://mongoc.org/libmongoc/current/authentication.html">http://mongoc.org/libmongoc/current/authentication.html</a>.</p><pre><code class="language-julia hljs">client = Mongoc.Client(&quot;mongodb://myUserAdmin:abc123@localhost/?authSource=admin&quot;)</code></pre><p>From MongoDB 4.0, there&#39;s a new authentication mechanism SCRAM-SHA-256, which replaces the previous SCRAM-SHA-1 mechanism. The correct authentication mechanism is negotiated between the driver and the server.</p><p>Alternatively, SCRAM-SHA-256 can be explicitly specified:</p><pre><code class="language-julia hljs">client = Mongoc.Client(&quot;mongodb://myUserAdmin:abc123@localhost/?authMechanism=SCRAM-SHA-256&amp;authSource=admin&quot;)</code></pre><p>Refer to the <a href="https://docs.mongodb.com/manual/security/">MongoDB manual</a> for adding new users and roles per database.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../crud/">« CRUD Operations</a><a class="docs-footer-nextpage" href="../transaction/">Transactions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 3 October 2023 19:26">Tuesday 3 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Mongoc.destroy!(client) # or exit julia session</code></pre><h4 id=".-Re-start-the-MongoDB-instance-with-access-control"><a class="docs-heading-anchor" href="#.-Re-start-the-MongoDB-instance-with-access-control">3. Re-start the MongoDB instance with access control</a><a id=".-Re-start-the-MongoDB-instance-with-access-control-1"></a><a class="docs-heading-anchor-permalink" href="#.-Re-start-the-MongoDB-instance-with-access-control" title="Permalink"></a></h4><p>Kill the previous process running <code>mongod</code> and then start server with auth option.</p><pre><code class="language-shell hljs">$ mongod --auth --dbpath ./db</code></pre><h3 id="Connect-and-authenticate"><a class="docs-heading-anchor" href="#Connect-and-authenticate">Connect and authenticate</a><a id="Connect-and-authenticate-1"></a><a class="docs-heading-anchor-permalink" href="#Connect-and-authenticate" title="Permalink"></a></h3><p>Pass the user and password in the URI, as described in <a href="http://mongoc.org/libmongoc/current/authentication.html">http://mongoc.org/libmongoc/current/authentication.html</a>.</p><pre><code class="language-julia hljs">client = Mongoc.Client(&quot;mongodb://myUserAdmin:abc123@localhost/?authSource=admin&quot;)</code></pre><p>From MongoDB 4.0, there&#39;s a new authentication mechanism SCRAM-SHA-256, which replaces the previous SCRAM-SHA-1 mechanism. The correct authentication mechanism is negotiated between the driver and the server.</p><p>Alternatively, SCRAM-SHA-256 can be explicitly specified:</p><pre><code class="language-julia hljs">client = Mongoc.Client(&quot;mongodb://myUserAdmin:abc123@localhost/?authMechanism=SCRAM-SHA-256&amp;authSource=admin&quot;)</code></pre><p>Refer to the <a href="https://docs.mongodb.com/manual/security/">MongoDB manual</a> for adding new users and roles per database.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../crud/">« CRUD Operations</a><a class="docs-footer-nextpage" href="../transaction/">Transactions »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 17 November 2023 13:33">Friday 17 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/connection_pool/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
client2 = Mongoc.Client(pool)
client3 = Mongoc.Client(pool)
client4 = Mongoc.Client(pool)</code></pre><p>When you reach the maximum number of clients, the next call to <code>Mongoc.Client(pool)</code> will block until a <code>Client</code> is released.</p><p>Use <code>try_pop=true</code> option to throw an error instead of blocking the current thread:</p><pre><code class="language-julia hljs"># will throw `AssertionError`
client5 = Mongoc.Client(pool, try_pop=true)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transaction/">« Transactions</a><a class="docs-footer-nextpage" href="../gridfs/">GridFS »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 3 October 2023 19:26">Tuesday 3 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
client5 = Mongoc.Client(pool, try_pop=true)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transaction/">« Transactions</a><a class="docs-footer-nextpage" href="../gridfs/">GridFS »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 17 November 2023 13:33">Friday 17 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/crud/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@
Mongoc.delete_one(collection, selector)

# deletes all elements in a collection
Mongoc.delete_many(collection, Mongoc.BSON()) # equivalent to `empty!(collection)`</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorial/">« Tutorial</a><a class="docs-footer-nextpage" href="../authentication/">Authentication »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 3 October 2023 19:26">Tuesday 3 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Mongoc.delete_many(collection, Mongoc.BSON()) # equivalent to `empty!(collection)`</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorial/">« Tutorial</a><a class="docs-footer-nextpage" href="../authentication/">Authentication »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 17 November 2023 13:33">Friday 17 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/gridfs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@
end</code></pre><h2 id="Find-and-Delete-files-in-Bucket"><a class="docs-heading-anchor" href="#Find-and-Delete-files-in-Bucket">Find and Delete files in Bucket</a><a id="Find-and-Delete-files-in-Bucket-1"></a><a class="docs-heading-anchor-permalink" href="#Find-and-Delete-files-in-Bucket" title="Permalink"></a></h2><p>Use <code>Mongoc.find</code> on a bucket to search for files, and <code>Mongoc.delete</code> to delete.</p><pre><code class="language-julia hljs">for doc in Mongoc.find(bucket)
println(&quot;Deleting $(doc[&quot;filename&quot;])&quot;)
Mongoc.delete(bucket, doc)
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../connection_pool/">« Connection Pool</a><a class="docs-footer-nextpage" href="../logging/">Logging »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 3 October 2023 19:26">Tuesday 3 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../connection_pool/">« Connection Pool</a><a class="docs-footer-nextpage" href="../logging/">Logging »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 17 November 2023 13:33">Friday 17 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 76e0686

Please sign in to comment.