Skip to content

Latest commit

 

History

History
97 lines (80 loc) · 3.89 KB

README.md

File metadata and controls

97 lines (80 loc) · 3.89 KB
Raw

Table of Contents

postgresql-async - an async Netty based PostgreSQL driver written in Scala 2.10 and 2.11

The main goal of this project is to implement a performant and fully functional async PostgreSQL driver. This project has no interest in JDBC, it's supposed to be a clean room implementation for people interested in talking directly to PostgreSQL.

PostgreSQL protocol information and definition can be found here

This driver contains Java code from the JDBC PostgreSQL driver under the com.github.mauricio.async.db.postgresql.util package consisting of the ParseURL class.

What can it do now?

  • connect to a database with or without authentication (supports MD5 and cleartext authentication methods)
  • receive database parameters
  • receive database notices
  • execute direct queries (without portals/prepared statements)
  • portals/prepared statements
  • parses most of the basic PostgreSQL types, other types are parsed as string
  • date, time and timestamp types are handled as JodaTime objects and not as java.util.Date objects
  • all work is done using the new scala.concurrent.Future and scala.concurrent.Promise objects
  • support for Byte arrays if using PostgreSQL >= 9.0
  • support for LISTEN/NOTIFY operations (check ListenNotifySpec for an example on how to use it );

What is missing?

  • more authentication mechanisms
  • benchmarks
  • more tests (run the jacoco:cover sbt task and see where you can improve)
  • timeout handler for initial handshare and queries
  • implement byte array support for PostgreSQL <= 8

Supported Scala/Java types and their destination types on PostgreSQL

All types also support their array versions, but they are returned as IndexedSeq of the type and not pure Array types.

PostgreSQL type | Scala/Java type --- | --- | --- boolean | Boolean smallint | Short integer (or serial) | Int bigint (or bigserial) | Long numeric | BigDecimal real | Float double | Double text | String varchar | String bpchar | String timestamp | LocalDateTime timestamp_with_timezone | DateTime date | LocalDate time | LocalTime bytea | Array[Byte] (PostgreSQL 9.0 and above only)

All other types are returned as String.

Now from Scala/Java types to PostgreSQL types (when using prepared statements):

Scala/Java type | PostgreSQL type --- | --- | --- Boolean | boolean Short | smallint Int | integer Long | bigint Float | float Double | double BigInteger | numeric BigDecimal | numeric String | varchar Array[Byte] | bytea (PostgreSQL 9.0 and above only) java.nio.ByteBuffer | bytea (PostgreSQL 9.0 and above only) io.netty.buffer.ByteBuf | bytea (PostgreSQL 9.0 and above only) java.util.Date | timestamp_with_timezone java.sql.Timestamp | timestamp_with_timezone java.sql.Date | date java.sql.Time | time LocalDate | date LocalDateTime | timestamp DateTime | timestamp_with_timezone LocalTime | time

Array types are encoded with the kind of object they hold and not the array type itself. Java Collection and Scala Traversable objects are also assumed to be arrays of the types they hold and will be sent to PostgreSQL like that.