Skip to content

Commit

Permalink
Removed travis-ci and added a link to the 1.7.0 release announcement
Browse files Browse the repository at this point in the history
  • Loading branch information
aaberg committed Mar 12, 2024
1 parent b1211fd commit ea1fd9f
Showing 1 changed file with 9 additions and 34 deletions.
43 changes: 9 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,21 @@
# sql2o [![Build Status](https://travis-ci.org/aaberg/sql2o.svg?branch=master)](https://travis-ci.org/aaberg/sql2o) [![Maven Central](https://img.shields.io/maven-central/v/org.sql2o/sql2o.svg)](https://search.maven.org/search?q=g:org.sql2o%20a:sql2o) [![Coverage Status](https://coveralls.io/repos/github/aaberg/sql2o/badge.svg?branch=master)](https://coveralls.io/github/aaberg/sql2o?branch=master)


# sql2o ![Github Actions Build](https://github.com/aaberg/sql2o/actions/workflows/pipeline.yml/badge.svg) [![Maven Central](https://img.shields.io/maven-central/v/org.sql2o/sql2o.svg)](https://search.maven.org/search?q=g:org.sql2o%20a:sql2o) [![Coverage Status](https://coveralls.io/repos/github/aaberg/sql2o/badge.svg?branch=master)](https://coveralls.io/github/aaberg/sql2o?branch=master)


Sql2o is a small java library, with the purpose of making database interaction easy.
When fetching data from the database, the ResultSet will automatically be filled into your POJO objects.
Kind of like an ORM, but without the SQL generation capabilities.
Sql2o requires at Java 7 or 8 to run. Java versions past 8 may work, but is currently not supported.

### Examples

Check out the [sql2o website](http://www.sql2o.org) for examples.

### Performance

A key feature of sql2o is performance. The following metrics were based off the
[Dapper.NET metrics](https://github.com/SamSaffron/dapper-dot-net#performance).
Note that *typical usage* can differ from *optimal usage* for many frameworks. Depending on the framework,
typical usage may not involve writing any SQL, or it may map underscore case to camel case, etc.
# Announcements
*2024-03-12* | [Sql2o 1.7.0 was released](https://github.com/aaberg/sql2o/discussions/365)

#### Performance of SELECT

Execute 1000 SELECT statements against a DB and map the data returned to a POJO.
Code is available [here](https://github.com/aaberg/sql2o/blob/master/core/src/test/java/org/sql2o/performance/PojoPerformanceTest.java).
# Examples

Method | Duration |
------------------------------------------------------------------- | ---------------------- |
Hand coded <code>ResultSet</code> | 60ms |
Sql2o | 75ms (25% slower) |
[Apache DbUtils](http://commons.apache.org/proper/commons-dbutils/) | 98ms (63% slower) |
[JDBI](http://jdbi.org/) | 197ms (228% slower) |
[MyBatis](http://mybatis.github.io/mybatis-3/) | 293ms (388% slower) |
[jOOQ](http://www.jooq.org) | 447ms (645% slower) |
[Hibernate](http://hibernate.org/) | 494ms (723% slower) |
[Spring JdbcTemplate](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/jdbc.html) | 636ms (960% slower) |

## Contributing

Want to contribute? Awesome! Here's how to set up.
Check out the [sql2o website](http://www.sql2o.org) for examples.

#### Coding guidelines.
# Coding guidelines.

When hacking sql2o, please follow [these coding guidelines](https://github.com/aaberg/sql2o/wiki/Coding-guidelines).

#### Note on running Oracle specific tests

In order to run the Oracle database tests you will have to add the Oracle Maven repo to your settings.xml as instructed in the [Oracle Fusion Middleware Maven Setup guide](https://maven.oracle.com/doc.html)

0 comments on commit ea1fd9f

Please sign in to comment.