This New branch is building upon the sqlite_test PR as it passed the testsuite

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
     branches: [main]
     tags: ["*"]
   pull_request:
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
   cancel-in-progress: true
@@ -46,6 +47,15 @@ jobs:
             ${{ runner.os }}-
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
+        env:
+          POSTGRES_USER: ${{ secrets.POSTGRES_USER }}
+          POSTGRES_HOST: ${{ secrets.POSTGRES_HOST }}
+          POSTGRES_PORT: ${{ secrets.POSTGRES_PORT }}
+          POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+          MYSQL_USER: ${{ secrets.MYSQL_USER }}
+          MYSQL_HOST: ${{ secrets.MYSQL_HOST }}
+          MYSQL_PORT: ${{ secrets.MYSQL_PORT }}
+          MYSQL_PASSWORD: ${{ secrets.MYSQL_PASSWORD }}
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v1
         with:

Project.toml

@@ -1,16 +1,18 @@
 name = "DBConnector"
 uuid = "5242bac9-aa14-4800-b46b-fcd14df13057"
-version = "1.0.0"
+authors = ["Jacob Zelko <[email protected]>", "Fareeda Abdelazeez"]
+version = "0.1.0"
 
 [deps]
 DBInterface = "a10d1c49-ce27-4219-8d33-6db1a4562965"
-JDBC = "6042db11-3c3d-5e84-8dba-9cbf74c9ba48"
 LibPQ = "194296ae-ab2e-5f79-8cd4-7183a0a5a0d1"
 MySQL = "39abe10b-433b-5dbd-92d4-e302a9df00cd"
-ODBC = "be6f12e9-ca4f-5eb2-a339-a4f995cc0291"
 SQLite = "0aa819cd-b072-5ff4-a722-6bc24af294d9"
 
 [compat]
+DBInterface = "2.5"
+LibPQ = "1.15"
+SQLite = "1.6"
 julia = "1.6"
 
 [extras]

docs/make.jl

@@ -1,5 +1,32 @@
-using Documenter, Example
+using DBConnector
+using Documenter
 
-makedocs(modules = [Example], sitename = "Example.jl")
+makedocs(;
+    modules = [DBConnector],
+    authors = "Jacob Zelko (aka TheCedarPrince) <[email protected]> and contributors",
+    repo = "https://github.com/JuliaHealth/DBConnector.jl/blob/{commit}{path}#L{line}",
+    sitename = "DBConnector.jl",
+    format = Documenter.HTML(;
+        prettyurls = get(ENV, "CI", "false") == "true",
+        canonical = "https://JuliaHealth.github.io/DBConnector.jl",
+        assets = String[],
+        edit_link = "dev",
+	footer = "Created by [Jacob Zelko](https://jacobzelko.com) & [Georgia Tech Research Institute](https://www.gtri.gatech.edu). [License](https://github.com/JuliaHealth/OMOPCDMCohortCreator.jl/blob/main/LICENSE)"
+    ),
+    pages = [
+        "Home" => "index.md",
+        "Tutorials" => [
+                        "SQLite.md",
+                        "MySQL.md",
+                        "postgreSQL.md"
+                       ],
+        "API" => "api.md",
+        "Contributing" => "contributing.md"
+    ],
+)
 
-deploydocs(repo = "github.com/quinnj/Example.jl.git", push_preview = true)
+deploydocs(;
+    repo = "github.com/JuliaHealth/DBConnector.jl",
+    push_preview = true,
+    devbranch = "main",
+)

docs/src/Tutorials/MySQL.md

@@ -0,0 +1,73 @@
+# MySQL Connection Tutorial 
+
+```@contents
+Pages = ["MySQL.md"]
+```
+
+This tutorial presents a step by step guide on using DBConnector to connect a MySQL database.
+
+### Prerequisites
+
+Basic knowledge of Julia (such as installing packages into environments and working with the Julia REPL and Julia files) is necessary; you can learn all [that here](https://pkgdocs.julialang.org/v1/getting-started/).
+
+Get your database's :
+
+        1- username
+        2- password
+        3- host
+        5- Database name
+
+        optional:
+        - port (3306 by default)
+        - unix_socket 
+        - client_flag
+        - opts=opts 
+
+
+## Environment Set-Up 
+
+For this tutorial, you will need to activate an environment; to get into package mode within your Julia REPL, write `]`:
+
+```julia-repl
+pkg> activate TUTORIAL
+```
+
+
+### Packages 
+
+
+
+You will need the following packages for this tutorial which you can install in package mode:
+
+"]" sets package mode
+
+```julia-repl
+TUTORIAL> add DBConnector
+```
+
+"Backspace" to return to Julia mode
+
+```
+using DBConnector
+
+conn= _dbconnect(MySQL.Connection, host, user, password, db=db)
+
+```
+In case you want to use the optional strings:
+
+```
+using DBConnector
+
+conn= _dbconnect(MySQL.Connection, host, user, password, db="the database name", port = 3306, unix_socket=unix_socket, client_flag=client_flag, opts=opts )
+
+```
+
+Now you are connected!
+
+Note: It produces error only in case the path is incorrect credentials
+
+### Packages Used in Analysis
+
+Package descriptions:
+
+- [`SQLite`](https://github.com/JuliaDatabases/SQLite.jl) - A Julia interface to the SQLite library

docs/src/Tutorials/SQLite.md

@@ -0,0 +1,49 @@
+# SQLite Connection Tutorial 
+
+```@contents
+Pages = ["SQLite.md"]
+```
+
+This tutorial presents a step by step guide on using DBConnector to connect a SQLite database.
+
+### Prerequisites
+
+Basic knowledge of Julia (such as installing packages into environments and working with the Julia REPL and Julia files) is necessary; you can learn all [that here](https://pkgdocs.julialang.org/v1/getting-started/).
+
+Get your database's file path
+
+## Environment Set-Up 
+
+For this tutorial, you will need to activate an environment; to get into package mode within your Julia REPL, write `]`:
+
+```julia-repl
+pkg> activate TUTORIAL
+```
+
+
+### Packages 
+
+
+
+You will need the following packages for this tutorial which you can install in package mode:
+
+"]" sets package mode
+
+```julia-repl
+TUTORIAL> add DBConnector
+```
+
+"Backspace" to return to Julia mode
+
+```
+conn= _dbconnect(SQLite.DB, "../test/data/sqlite.db")
+```
+Now you are connected! and if the file wasn't exist it will be created!
+
+Note: It produces error only in case the path is incorrect
+
+### Packages Used in Analysis
+
+Package descriptions:
+
+- [`SQLite`](https://github.com/JuliaDatabases/SQLite.jl) - A Julia interface to the SQLite library

docs/src/Tutorials/postgreSQL.md

@@ -0,0 +1,84 @@
+# PostgreSQL Connection Tutorial 
+
+```@contents
+Pages = ["PostgreSQL.md"]
+```
+
+This tutorial presents a step by step guide on using DBConnector to connect to PostgreSQL database using LibPQ library.
+
+### Prerequisites
+
+Basic knowledge of Julia (such as installing packages into environments and working with the Julia REPL and Julia files) is necessary; you can learn all [that here](https://pkgdocs.julialang.org/v1/getting-started/).
+
+Get your database's :
+
+        1- username
+        2- password
+
+
+        optional:
+        - host
+        - Database name
+        - port (5432 by default)
+
+Note: If you have additional keys that are necessary to be added, Jump to Method 2: 
+
+## Environment Set-Up 
+
+For this tutorial, you will need to activate an environment; to get into package mode within your Julia REPL, write `]`:
+
+```julia-repl
+pkg> activate TUTORIAL
+```
+
+
+### Packages 
+
+
+
+You will need the following packages for this tutorial which you can install in package mode:
+
+"]" sets package mode
+
+```julia-repl
+TUTORIAL> add DBConnector
+```
+
+"Backspace" to return to Julia mode
+
+```
+using DBConnector
+
+conn= _dbconnect(LibPQ.Connection; host = host, user = user, password = password, db=db)
+
+```
+In case you want to use the optional strings:
+
+```
+using DBConnector
+
+conn= _dbconnect(LibPQ.Connection; host = host, user = user, password = password, db="the database name", port = 5432)
+
+```
+
+
+
+Now you are connected!
+
+Note: It produces error only in case the path is incorrect credentials
+
+# Method 2
+
+create your own connection string as this example:
+
+```
+connection_string = "postgresql://username:password@unix:/path/to/socket/directory/database_name"
+
+conn= _dbconnect(LibPQ.Connection, connection_string)
+```
+
+### Packages Used in Analysis
+
+Package descriptions:
+
+- [LibPQ](https://github.com/chris-b1/LibPQ.jl#dbinterface) - A Julia interface to the LibPQ library

docs/src/index.md

@@ -1,7 +1,18 @@
-# Example
+# Welcome to the `DBConnector.jl` Docs
+
+> Get your credentials and connect to databases in one step with DBConnector!
+
+
+To get started, visit the section as well as visit the visit the [Tutorials](@ref) section to see all the functions available.
+If you want to contribute, please check out our guide!
+
+## Main Features 🔧
+
+The biggest features of this package are:
+
+  - "SQLite" functions [SQLite](@ref) a database 
+  - "MySQL" functions to [MySQL](@ref) a database 
+  - "PostgreSQL" functions to [postgreSQL](@ref) database connections
+
 
-Example Julia package repo.
 
-```@autodocs
-Modules = [Example]
-```

docs/src/tutorials.md

@@ -0,0 +1,11 @@
+# Tutorials
+
+```@contents
+Pages = ["tutorials.md"]
+```
+
+These tutorials are designed to equip new users with how to get started with DBConnector
+
+  - "SQLite" functions [SQLite](@ref) a database 
+  - "MySQL" functions to [MySQL](@ref) a database 
+  - "PostgreSQL" functions to [postgreSQL](@ref) database connections