diff --git a/docs/src/index.md b/docs/src/index.md index 901c2e3d..1f3b3e51 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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: + +* 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 + +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. ### Selection