mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
194 lines
13 KiB
HTML
194 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>module GxG::Database - RDoc Documentation</title>
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "../";
|
|
var index_rel_prefix = "../";
|
|
</script>
|
|
|
|
<script src="../js/navigation.js" defer></script>
|
|
<script src="../js/search.js" defer></script>
|
|
<script src="../js/search_index.js" defer></script>
|
|
<script src="../js/searcher.js" defer></script>
|
|
<script src="../js/darkfish.js" defer></script>
|
|
|
|
<link href="../css/fonts.css" rel="stylesheet">
|
|
<link href="../css/rdoc.css" rel="stylesheet">
|
|
|
|
|
|
|
|
<body id="top" role="document" class="module">
|
|
<nav role="navigation">
|
|
<div id="project-navigation">
|
|
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
<h2>
|
|
<a href="../index.html" rel="home">Home</a>
|
|
</h2>
|
|
|
|
<div id="table-of-contents-navigation">
|
|
<a href="../table_of_contents.html#pages">Pages</a>
|
|
<a href="../table_of_contents.html#classes">Classes</a>
|
|
<a href="../table_of_contents.html#methods">Methods</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<div id="search-field-wrapper">
|
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
aria-autocomplete="list" aria-controls="search-results"
|
|
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</div>
|
|
|
|
<ul id="search-results" aria-label="Search Results"
|
|
aria-busy="false" aria-expanded="false"
|
|
aria-atomic="false" class="initially-hidden"></ul>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="class-metadata">
|
|
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="nav-section">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="link-list" role="directory">
|
|
|
|
<li ><a href="#method-c-connect">::connect</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="module-GxG::Database">
|
|
<h1 id="module-GxG::Database" class="module">
|
|
module GxG::Database
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-connect" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">connect</span><span
|
|
class="method-args">(the_url, options={})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="connect-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_database.rb, line 10</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">connect</span>(<span class="ruby-identifier">the_url</span>, <span class="ruby-identifier">options</span>={})
|
|
<span class="ruby-comment"># TODO: require :credential (access privs)</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-comment"># check for URI ipv6 [format] compatibility</span>
|
|
<span class="ruby-identifier">db_url</span> = <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">to_s</span>)
|
|
<span class="ruby-identifier">the_path</span> = <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_path</span> <span class="ruby-operator">==</span> <span class="ruby-string">""</span>
|
|
<span class="ruby-identifier">the_path</span> = <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">hostname</span>.<span class="ruby-identifier">to_s</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">RUBY_ENGINE</span> <span class="ruby-operator">==</span> <span class="ruby-string">"jruby"</span>
|
|
<span class="ruby-keyword">case</span> <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_sym</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:sqlite</span>, <span class="ruby-value">:sqlite3</span>
|
|
<span class="ruby-keyword">if</span> [<span class="ruby-string">"/memory"</span>, <span class="ruby-string">"memory"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">the_path</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">"jdbc:sqlite::memory:"</span>)
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">"jdbc:sqlite:"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">the_path</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>({<span class="ruby-value">:adapter</span> <span class="ruby-operator">=></span> (<span class="ruby-string">"jdbc:"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:host</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">hostname</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:database</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>).<span class="ruby-identifier">last</span>), <span class="ruby-value">:user</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:password</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">password</span>.<span class="ruby-identifier">to_s</span>)})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">case</span> <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_sym</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:sqlite</span>, <span class="ruby-value">:sqlite3</span>
|
|
<span class="ruby-keyword">if</span> [<span class="ruby-string">"/memory"</span>, <span class="ruby-string">"memory"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">the_path</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">"sqlite::memory:"</span>)
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">"sqlite://"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">the_path</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-comment"># auto-forward to mysql2 gem if mysql:// scheme</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">==</span> <span class="ruby-string">"mysql"</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>({<span class="ruby-value">:adapter</span> <span class="ruby-operator">=></span> <span class="ruby-string">"mysql2"</span>, <span class="ruby-value">:host</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">hostname</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:database</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>).<span class="ruby-identifier">last</span>), <span class="ruby-value">:user</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:password</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">password</span>.<span class="ruby-identifier">to_s</span>)})
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>({<span class="ruby-value">:adapter</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:host</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">hostname</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:database</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>).<span class="ruby-identifier">last</span>), <span class="ruby-value">:user</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:password</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">password</span>.<span class="ruby-identifier">to_s</span>)})
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>)}))
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">the_url</span>), <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">options</span>)}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
</section>
|
|
</main>
|
|
|
|
|
|
<footer id="validator-badges" role="contentinfo">
|
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|