Radiology-CDM / Git / [58c332] /archives/RadETL/docs/reference/DBMSIO.html

Models:
SCallahan/
Radiology-CDM
Downloads: 1
[58c332]: / archives / RadETL / docs / reference / DBMSIO.html
History
Download this file
209 lines (154 with data), 9.7 kB

<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
  <head>
  <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>DBMSIO Class — DBMSIO • RadETL</title>

<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />

<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>



<meta property="og:title" content="DBMSIO Class — DBMSIO" />

<meta property="og:description" content="This class is a DBMS I/O class created using the DatabaseConnector package." />
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->


  </head>

  <body>
    <div class="container template-reference-topic">
      <header>
      <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">RadETL</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      
      </header>

<div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>DBMSIO Class</h1>
    
    <div class="hidden name"><code>DBMSIO.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>This class is a DBMS I/O class created using the DatabaseConnector package.</p>
    
    </div>

    <pre class="usage"><span class='no'>DBMSIO</span></pre>
    
    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
      <th>server</th>
      <td><p>Enter the server address to access (See http://ohdsi.github.io/DatabaseConnector/reference/connect.html)</p></td>
    </tr>
    <tr>
      <th>user</th>
      <td><p>Enter the user ID of the DBMS you want to access</p></td>
    </tr>
    <tr>
      <th>pw</th>
      <td><p>Enter the password for the DBMS you want to access.</p></td>
    </tr>
    <tr>
      <th>dbms</th>
      <td><p>Enter the DBMS type. ex: sql server, oracle</p></td>
    </tr>
    </table>
    
    <h2 class="hasAnchor" id="format"><a class="anchor" href="#format"></a>Format</h2>

    <p>An object of class <code>R6ClassGenerator</code> of length 24.</p>
    

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><span class='co'># NOT RUN {</span>
<span class='co'>############################# Example Code: Data frame transfer RDBMS.. #############################</span>

<span class='co'># First, connect RDBMS</span>
<span class='co'># I'm not recommend to input server information in programming code (Security issues)</span>
<span class='co'># So, I recommend to use environment variables in operating system</span>
<span class='no'>dbms</span> <span class='kw'>&lt;-</span> <span class='st'>"sql server"</span>
<span class='no'>user</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/Sys.getenv'>Sys.getenv</a></span>(<span class='st'>"user"</span>)
<span class='no'>pw</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/Sys.getenv'>Sys.getenv</a></span>(<span class='st'>"pw"</span>)
<span class='no'>server</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/Sys.getenv'>Sys.getenv</a></span>(<span class='st'>"dbServer"</span>)

<span class='co'># Choose Database name</span>
<span class='no'>databaseSchema</span> <span class='kw'>&lt;-</span> <span class='st'>'Radiology_CDM_QUER.dbo'</span>

<span class='co'># Using DatabaseConnector package</span>
<span class='no'>io</span> <span class='kw'>&lt;-</span> <span class='no'>DBMSIO</span>$<span class='fu'>new</span>(<span class='kw'>server</span> <span class='kw'>=</span> <span class='no'>server</span>, <span class='kw'>user</span> <span class='kw'>=</span> <span class='no'>user</span>, <span class='kw'>pw</span> <span class='kw'>=</span> <span class='no'>pw</span>, <span class='kw'>dbms</span> <span class='kw'>=</span> <span class='no'>dbms</span>)

<span class='co'># df is radiology Data frame,,</span>
<span class='co'># The insertDB method checks the row in the data frame and automatically inserts the table name.</span>
<span class='co'># If the data frame does not fit the R-CDM, an error occurs.</span>
<span class='co'># You can also inherit the insertTable from the DatabaseConnector package to accept the options for that function.</span>
<span class='co'># e.q dropTableIfExists etc.</span>
<span class='no'>io</span>$<span class='fu'>insertDB</span>(<span class='kw'>dbS</span> <span class='kw'>=</span> <span class='no'>databaseSchema</span>, <span class='kw'>df</span> <span class='kw'>=</span> <span class='no'>df</span>)

<span class='co'>################################## Example Code: Get data for RDBMS.... #############################</span>

<span class='co'># Using DBMSIO class in RadETL package</span>
<span class='co'># table schema names are Radiology_Image and Radiology_Occurrence</span>
<span class='no'>tbSchema</span> <span class='kw'>&lt;-</span> <span class='st'>"Radiology_Occurrence"</span>
<span class='no'>df</span> <span class='kw'>&lt;-</span> <span class='no'>io</span>$<span class='fu'>dbGetdtS</span>(<span class='kw'>dbS</span> <span class='kw'>=</span> <span class='no'>databaseSchema</span>, <span class='kw'>tbS</span> <span class='kw'>=</span> <span class='no'>tbSchema</span>)

<span class='co'># include conditions....</span>
<span class='no'>df</span> <span class='kw'>&lt;-</span> <span class='no'>io</span>$<span class='fu'>dbGetdtS</span>(<span class='kw'>dbS</span> <span class='kw'>=</span> <span class='no'>databaseSchema</span>, <span class='kw'>tbS</span> <span class='kw'>=</span> <span class='no'>tbSchema</span>, <span class='kw'>condition</span> <span class='kw'>=</span> <span class='st'>"Image_total_count &lt; 20"</span>)
<span class='no'>df</span>$<span class='no'>RADIOLOGY_OCCURRENCE_ID</span>

<span class='co'># if want disconnect (required)</span>
<span class='no'>io</span>$<span class='fu'>finalize</span>()

<span class='co'>######################################## Example Code: END ##########################################</span>
<span class='co'># }</span></pre>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
    <h2>Contents</h2>
    <ul class="nav nav-pills nav-stacked">
      <li><a href="#arguments">Arguments</a></li>
      
      <li><a href="#format">Format</a></li>
      
      <li><a href="#examples">Examples</a></li>
    </ul>

    <h2>Author</h2>
    <p>Neon K.I.D</p>
  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by K.I.D Neon.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.9000.</p>
</div>
      </footer>
   </div>

  

  </body>
</html>