Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/potix2/spark-google-spreadsheets

Google Spreadsheets datasource for SparkSQL and DataFrames
https://github.com/potix2/spark-google-spreadsheets

data-frame scala spark sparksql spreadsheet

Last synced: 3 months ago
JSON representation

Google Spreadsheets datasource for SparkSQL and DataFrames

Awesome Lists containing this project

README

        

# Spark Google Spreadsheets

Google Spreadsheets datasource for [SparkSQL and DataFrames](http://spark.apache.org/docs/latest/sql-programming-guide.html)

[![Build Status](https://travis-ci.org/potix2/spark-google-spreadsheets.svg?branch=master)](https://travis-ci.org/potix2/spark-google-spreadsheets)

## Notice

The version 0.4.0 breaks compatibility with previous versions. You must
use a ** spreadsheetId ** to identify which spreadsheet is to be accessed or altered.
In older versions, spreadsheet name was used.

If you don't know spreadsheetId, please read the [Introduction to the Google Sheets API v4](https://developers.google.com/sheets/guides/concepts).

## Requirements

This library supports different versions of Spark:

### Latest compatible versions

| This library | Spark Version |
| ------------ | ------------- |
| 0.6.x | 2.3.x, 2.4.x |
| 0.5.x | 2.0.x |
| 0.4.x | 1.6.x |

## Linking

Using SBT:

```
libraryDependencies += "com.github.potix2" %% "spark-google-spreadsheets" % "0.6.3"
```

Using Maven:

```xml

com.github.potix2
spark-google-spreadsheets_2.11
0.6.3

```

## SQL API

```sql
CREATE TABLE cars
USING com.github.potix2.spark.google.spreadsheets
OPTIONS (
path "/worksheet1",
serviceAccountId "[email protected]",
credentialPath "/path/to/credential.p12"
)
```

## Scala API

```scala
import org.apache.spark.sql.SQLContext

val sqlContext = new SQLContext(sc)

// Creates a DataFrame from a specified worksheet
val df = sqlContext.read.
format("com.github.potix2.spark.google.spreadsheets").
option("serviceAccountId", "[email protected]").
option("credentialPath", "/path/to/credential.p12").
load("/worksheet1")

// Saves a DataFrame to a new worksheet
df.write.
format("com.github.potix2.spark.google.spreadsheets").
option("serviceAccountId", "[email protected]").
option("credentialPath", "/path/to/credential.p12").
save("/newWorksheet")

```

### Using Google default application credentials

Provide authentication credentials to your application code by setting the environment variable
`GOOGLE_APPLICATION_CREDENTIALS`. The variable should be set to the path of the service account json file.

```scala
import org.apache.spark.sql.SQLContext

val sqlContext = new SQLContext(sc)

// Creates a DataFrame from a specified worksheet
val df = sqlContext.read.
format("com.github.potix2.spark.google.spreadsheets").
load("/worksheet1")
```

More details: https://cloud.google.com/docs/authentication/production

## License

Copyright 2016-2018, Katsunori Kanda

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.