Skip to content

Commit

Permalink
Deploying to gh-pages from @ a2b9956 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@wangxiaoying
wangxiaoying committed Oct 18, 2024
1 parent c2f9135 commit fbc760d
Show file tree
Hide file tree
Showing 351 changed files with 13,114 additions and 12,844 deletions.
14 changes: 10 additions & 4 deletions _sources/databases/mssql.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ SQLServer does not need to specify protocol.

### MsSQL Connection
```{hint}
By adding `trusted_connection=true` to connection uri parameter, windows authentication will be enabled. Example: `mssql://host:port/db?trusted_connection=true`
By adding `encrypt=true` to connection uri parameter, SQLServer will use SSL encryption. Example: `mssql://host:port/db?encrypt=true&trusted_connection=true`
```
```{hint}
if the user password has special characters, they need to be sanitized. example: `from urllib import parse; password = parse.quote_plus(password)`
```

Expand All @@ -20,6 +16,16 @@ query = 'SELECT * FROM table' # query string
cx.read_sql(conn, query) # read data from MsSQL
```

### Connection Parameters
* By adding `trusted_connection=true` to connection uri parameter, windows authentication will be enabled.
* Example: `mssql://host:port/db?trusted_connection=true`
* By adding `encrypt=true` to connection uri parameter, SQLServer will use SSL encryption.
* Example: `mssql://host:port/db?encrypt=true&trusted_connection=true`
* By adding `trust_server_certificate=true` to connection uri parameter, the SQLServer certificate will not be validated and it is accepted as-is.
* Example: `mssql://host:port/db?trust_server_certificate=true&encrypt=true`
* By adding `trust_server_certificate_ca=/path/to/ca-cert.crt` to connection uri parameter, the SQLServer certificate will be validated against the given CA certificate in addition to the system-truststore.
* Example: `mssql://host:port/db?encrypt=true&trust_server_certificate_ca=/path/to/ca-cert.crt`

### SQLServer-Pandas Type Mapping
| SQLServer Type | Pandas Type | Comment |
|:---------------:|:---------------------------:|:----------------------------------:|
Expand Down
32 changes: 27 additions & 5 deletions databases/mssql.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,7 @@ <h2> Contents </h2>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mssql-connection">MsSQL Connection</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#connection-parameters">Connection Parameters</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#sqlserver-pandas-type-mapping">SQLServer-Pandas Type Mapping</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#performance-r5-4xlarge-docker-in-another-ec2-instance">Performance (r5.4xlarge docker in another EC2 instance)</a></li>
</ul>
Expand All @@ -411,11 +412,6 @@ <h1>MsSQL<a class="headerlink" href="#mssql" title="Link to this heading">#</a><
<h2>MsSQL Connection<a class="headerlink" href="#mssql-connection" title="Link to this heading">#</a></h2>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>By adding <code class="docutils literal notranslate"><span class="pre">trusted_connection=true</span></code> to connection uri parameter, windows authentication will be enabled. Example: <code class="docutils literal notranslate"><span class="pre">mssql://host:port/db?trusted_connection=true</span></code>
By adding <code class="docutils literal notranslate"><span class="pre">encrypt=true</span></code> to connection uri parameter, SQLServer will use SSL encryption. Example: <code class="docutils literal notranslate"><span class="pre">mssql://host:port/db?encrypt=true&amp;trusted_connection=true</span></code></p>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>if the user password has special characters, they need to be sanitized. example: <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">urllib</span> <span class="pre">import</span> <span class="pre">parse;</span> <span class="pre">password</span> <span class="pre">=</span> <span class="pre">parse.quote_plus(password)</span></code></p>
</div>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">connectorx</span> <span class="k">as</span> <span class="nn">cx</span>
Expand All @@ -425,6 +421,31 @@ <h2>MsSQL Connection<a class="headerlink" href="#mssql-connection" title="Link t
</pre></div>
</div>
</section>
<section id="connection-parameters">
<h2>Connection Parameters<a class="headerlink" href="#connection-parameters" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>By adding <code class="docutils literal notranslate"><span class="pre">trusted_connection=true</span></code> to connection uri parameter, windows authentication will be enabled.</p>
<ul>
<li><p>Example: <code class="docutils literal notranslate"><span class="pre">mssql://host:port/db?trusted_connection=true</span></code></p></li>
</ul>
</li>
<li><p>By adding <code class="docutils literal notranslate"><span class="pre">encrypt=true</span></code> to connection uri parameter, SQLServer will use SSL encryption.</p>
<ul>
<li><p>Example: <code class="docutils literal notranslate"><span class="pre">mssql://host:port/db?encrypt=true&amp;trusted_connection=true</span></code></p></li>
</ul>
</li>
<li><p>By adding <code class="docutils literal notranslate"><span class="pre">trust_server_certificate=true</span></code> to connection uri parameter, the SQLServer certificate will not be validated and it is accepted as-is.</p>
<ul>
<li><p>Example: <code class="docutils literal notranslate"><span class="pre">mssql://host:port/db?trust_server_certificate=true&amp;encrypt=true</span></code></p></li>
</ul>
</li>
<li><p>By adding <code class="docutils literal notranslate"><span class="pre">trust_server_certificate_ca=/path/to/ca-cert.crt</span></code> to connection uri parameter, the SQLServer certificate will be validated against the given CA certificate in addition to the system-truststore.</p>
<ul>
<li><p>Example: <code class="docutils literal notranslate"><span class="pre">mssql://host:port/db?encrypt=true&amp;trust_server_certificate_ca=/path/to/ca-cert.crt</span></code></p></li>
</ul>
</li>
</ul>
</section>
<section id="sqlserver-pandas-type-mapping">
<h2>SQLServer-Pandas Type Mapping<a class="headerlink" href="#sqlserver-pandas-type-mapping" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="table">
Expand Down Expand Up @@ -615,6 +636,7 @@ <h2>Performance (r5.4xlarge docker in another EC2 instance)<a class="headerlink"
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mssql-connection">MsSQL Connection</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#connection-parameters">Connection Parameters</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#sqlserver-pandas-type-mapping">SQLServer-Pandas Type Mapping</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#performance-r5-4xlarge-docker-in-another-ec2-instance">Performance (r5.4xlarge docker in another EC2 instance)</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion rust-docs/connectorx/all.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion rust-docs/connectorx/arrow_batch_iter/fn.set_global_num_thread.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `set_global_num_thread` fn in crate `connectorx`."><title>set_global_num_thread in connectorx::arrow_batch_iter - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="connectorx" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../connectorx/index.html">connectorx</a><span class="version">0.3.4-alpha.2</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In connectorx::arrow_batch_iter</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">connectorx</a>::<wbr><a href="index.html">arrow_batch_iter</a>::<wbr><a class="fn" href="#">set_global_num_thread</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/connectorx/arrow_batch_iter.rs.html#8-13">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn set_global_num_thread(num: <a class="primitive" href="https://doc.rust-lang.org/1.81.0/std/primitive.usize.html">usize</a>)</code></pre></section></div></main></body></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `set_global_num_thread` fn in crate `connectorx`."><title>set_global_num_thread in connectorx::arrow_batch_iter - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="connectorx" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../connectorx/index.html">connectorx</a><span class="version">0.3.4-alpha.2</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In connectorx::<wbr>arrow_<wbr>batch_<wbr>iter</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">connectorx</a>::<wbr><a href="index.html">arrow_batch_iter</a>::<wbr><a class="fn" href="#">set_global_num_thread</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/connectorx/arrow_batch_iter.rs.html#8-13">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn set_global_num_thread(num: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.usize.html">usize</a>)</code></pre></section></div></main></body></html>
Loading

0 comments on commit fbc760d

Please sign in to comment.