Skip to content

Update index.md with an overview section #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update index.md with an overview section #243

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66cbb88
Update index.md
logankilpatrick Jan 28, 2022
c5204c6
Update index.md
logankilpatrick Jan 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,32 @@
[![Build Status](https://travis-ci.com/invenia/LibPQ.jl.svg?branch=master)](https://travis-ci.com/invenia/LibPQ.jl)
[![CodeCov](https://codecov.io/gh/invenia/LibPQ.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/invenia/LibPQ.jl)

## Overview

LibPQ.jl is a Julia wrapper for the PostgreSQL libpq C library. It provides the ability to:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
LibPQ.jl is a Julia wrapper for the PostgreSQL libpq C library. It provides the ability to:
LibPQ.jl is a Julia wrapper for the PostgreSQL `libpq` C library. It provides the ability to:


* Build
* Installs `libpq` via `BinaryBuilder.jl` for MacOS, GNU Linux, and Windows
* Connections
* Connect via DSN
* Connect via PostgreSQL connection string
* UTF-8 client encoding
* Queries
* Create and execute queries with or without parameters
* Execute queries asynchronously
* Stream results using [Tables](https://github.com/JuliaData/Tables.jl)
* Configurably convert a variety of PostgreSQL types to corresponding Julia types (see the **Type Conversions** section of the docs)
* Prepared Statements
* Create and execute prepared statements with or without parameters
* Stream table of parameters to execute the same statement multiple times with different data
Comment on lines +12 to +25
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs adjustment to match the wording of the pre-colon sentence. E.g.:

Suggested change
* Build
* Installs `libpq` via `BinaryBuilder.jl` for MacOS, GNU Linux, and Windows
* Connections
* Connect via DSN
* Connect via PostgreSQL connection string
* UTF-8 client encoding
* Queries
* Create and execute queries with or without parameters
* Execute queries asynchronously
* Stream results using [Tables](https://github.com/JuliaData/Tables.jl)
* Configurably convert a variety of PostgreSQL types to corresponding Julia types (see the **Type Conversions** section of the docs)
* Prepared Statements
* Create and execute prepared statements with or without parameters
* Stream table of parameters to execute the same statement multiple times with different data
* Install `libpq`
* Installs `libpq` via `BinaryBuilder.jl` for MacOS, GNU Linux, and Windows
* Create Connections
* Connect via DSN
* Connect via PostgreSQL connection string
* UTF-8 client encoding
* Run Queries
* Create and execute queries with or without parameters
* Execute queries asynchronously
* Stream results using [Tables](https://github.com/JuliaData/Tables.jl)
* Configurably convert a variety of PostgreSQL types to corresponding Julia types (see the **Type Conversions** section of the docs)
* Use Prepared Statements
* Create and execute prepared statements with or without parameters
* Stream table of parameters to execute the same statement multiple times with different data


You can install `LibPQ.jl` via the Julia REPL by typing:
```julia
] add LibPQ
```

## Examples
The below examples assume you already have a database created. If you don't have one setup yet, you will need to do so for the following snippets to work.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The below examples assume you already have a database created. If you don't have one setup yet, you will need to do so for the following snippets to work.
The below examples assume you already have a database created. If you don't have one setup yet, you will need to do so for the following snippets to work.


### Selection

Expand Down