Skip to content

Commit

Permalink
some more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drizk1 committed Apr 5, 2024
1 parent 7d32127 commit c997943
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## What is TidierDB.jl

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/TidierOrg/TidierDB.jl/blob/main/LICENSE)
[![Docs: Latest](https://img.shields.io/badge/Docs-Latest-blue.svg)](https://tidierorg.github.io/TidierDB.jl/latest)

TiderDB.jl is a 100% Julia implementation of the dbplyr R package (and similar to python's ibis package).

The main goal of TidierDB.jl is to bring the ease of use and simple syntax of Tidier.jl to mutliple SQL backends,
Expand Down
13 changes: 13 additions & 0 deletions docs/examples/UserGuide/getting_started.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# To use TidierDB.jl, you will have to set up a connection. TidierDB.jl gives you access to duckdb via `duckdb_open` and `duckdb_connect`. However, to use MySql, ClickHouse, MSSQL, Postgres, or SQLite, you will have to load that packages in first.

# The associated databased packages used to set up connections are currently as follows

# - ClickHouse - ClickHouse.jl
# - MySQL - MySQL.jl
# - MSSQL - ODBC.jl
# - Postgres - LibPQ.jl
# - SQLite - SQLite.jl

# For DuckDB, SQLite, and MySQL, `copy_to` lets you copy data to the database and query there. ClickHouse, MSSQL, and Postgres support for `copy_to` has not been added yet.

# After the connection is set up and the data is available, TidierDB.jl will take care of the rest of your querying needs.
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,5 @@ plugins:
nav:
- "Home": "index.md"
- "Key Differences from TidierData.jl" : "examples/generated/UserGuide/key_differences.md"
- "Getting Started": "examples/generated/UserGuide/getting_started.md"
- "Reference" : "reference.md"
2 changes: 1 addition & 1 deletion src/docstrings.jl
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@ Allows user to copy a df to the database connection. Currently supports DuckDB,
# Arguments
-`conn`: the database connection
-`df`: dataframe to be copied or path to serve as source. Path supports .csv, .json, .parquet to be used without copying intermediary df when using duckdb
-`df`: dataframe to be copied or path to serve as source. With DuckDB, path supports .csv, .json, .parquet to be used without copying intermediary df.
-`name`: name as string for the database to be used
# Examples
```jldoctest
Expand Down

0 comments on commit c997943

Please sign in to comment.