Skip to content
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.

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

Update index.md with an overview section #243

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

Conversation

logankilpatrick
Copy link

No description provided.

@iamed2
Copy link
Collaborator

iamed2 commented Jan 29, 2022

I think this should probably roughly match the Current feature set from the README.

## 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.

Comment on lines +12 to +25
* 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
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

@@ -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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants