diff --git a/README.md b/README.md index a073b871..ff956f27 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,38 @@ ![Maven Central](https://img.shields.io/maven-central/v/com.github.jonathanswenson/bqjdbc) -A fat (shaded) jar is provided at the following coordinates: +This is a [JDBC Driver](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) for [BigQuery](https://cloud.google.com/bigquery) +forked from https://code.google.com/p/starschema-bigquery-jdbc/ + +You can create a JDBC connection easily for a variety of authentication types. +For instance for a _service account_ in a properties file: + +```ini +projectid=disco-parsec-659 +type=service +user=abc123e@developer.gserviceaccount.com +password=bigquery_credentials.p12 +``` + +```java +import net.starschema.clouddb.jdbc.*; +import java.sql.*; + +public static class Example { + public static void main(String[] args) { + // load the class so that it registers itself + Class.forName("net.starschema.clouddb.jdbc.BQDriver"); + final String jdbcUrl = BQSupportFuncts.constructUrlFromPropertiesFile( + BQSupportFuncts.readFromPropFile( + getClass().getResource("/serviceaccount.properties").getFile() + )); + final Connection con = DriverManager.getConnection(jdbcUrl); + // perform SQL against BigQuery now! + } +} +``` + +The dependency is provided at the following coordinates: ```xml com.github.jonathanswenson @@ -11,18 +42,19 @@ A fat (shaded) jar is provided at the following coordinates: ``` -If you would like a thin jar you can use _thin_ classifier. - +A fat (shaded) jar is provided at the following coordinates. ```xml com.github.jonathanswenson bqjdbc ... - thin + shaded ``` -## Releases +## Development + +### Releases Releases are handled through GitHub actions, and kicked off when a release is created. diff --git a/pom.xml b/pom.xml index 2dddca99..f7a153e9 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ to a groupId that we have ownership over --> com.github.jonathanswenson bqjdbc - 2.2.12-SNAPSHOT + 2.2.13 Big Query over JDBC A simple JDBC driver, to reach Google's BigQuery @@ -191,7 +191,7 @@ - ${project.artifactId}-${project.version} + true @@ -247,6 +247,5 @@ - ${project.artifactId}-${project.version}-thin