microsoft / osdu-spark

Spark connector for OSDU

Spark Datasource Connector for Open Subsurface Data Universe (OSDU)

Features

• Surface OSDU records as Spark data frames
• Filtering by
  • Kind
  • Query (see OSDU query syntax)
• Translation of OSDU schema to Spark schema
  • Primitive types (string, integer, double, float, date, bool,...)
  • Arrays
  • Objects
  • Maps
• Column pruning: based on selected fields on the Spark side, only the requested columns are requested and transferred by the OSDU instance

Installation

Synapse

%%configure -f
{
  "name": "synapseml",
  "conf": {
      "spark.jars.packages": "com.microsoft.spark:osdu-spark-connector_2.12:1.0.0"
  }
}

Databricks

Coordinates: com.microsoft.spark:osdu-spark-connector_2.12:1.0.0

Python

import pyspark
spark = pyspark.sql.SparkSession.builder.appName("MyApp") \
            .config("spark.jars.packages", "com.microsoft.spark:osdu-spark-connector_2.12:1.0.0") \
            .getOrCreate()

Read Example

    val sampleDf = sc.read
        .format("com.microsoft.spark.osdu")
        .option("kind", "osdu:wks:master-data--GeoPoliticalEntity:1.0.0")
        .option("query", "")
        .option("osduApiEndpoint", "<INSERT>")
        .option("partitionId", "<INSERT>")  // OSDU data partition ID
        .option("bearerToken","<INSERT>")
        .load

    sampleDf.printSchema()

    sampleDf.show()

Output

root
|-- data: struct (nullable = true)
|    |-- ParentGeoPoliticalEntityID: string (nullable = true)
|    |-- GeoPoliticalEntityTypeID: string (nullable = true)
|    |-- TerminationDate: string (nullable = true)
|    |-- DisputedIndicator: boolean (nullable = true)
|    |-- DaylightSavingTimeStartDate: string (nullable = true)
|    |-- GeoPoliticalEntityName: string (nullable = true)
|    |-- GeoPoliticalEntityID: string (nullable = true)
|    |-- DaylightSavingTimeEndDate: string (nullable = true)
|    |-- EffectiveDate: string (nullable = true)
|-- kind: string (nullable = false)
|-- version: integer (nullable = true)
|-- modifyUser: string (nullable = true)
|-- modifyTime: string (nullable = true)
|-- createTime: string (nullable = true)
|-- status: string (nullable = true)
|-- createUser: string (nullable = true)
|-- id: string (nullable = true)

+--------------------+--------------------+----------+----------+----------+--------------------+------+--------------------+--------------------+
|                data|                kind|   version|modifyUser|modifyTime|          createTime|status|          createUser|                  id|
+--------------------+--------------------+----------+----------+----------+--------------------+------+--------------------+--------------------+
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
|[,,,,, United Sta...|osdu:wks:master-d...|2147483647|      null|      null|2022-01-18T17:18:...|  null|2f59abbc-7b40-4d0...|osdukmtest-opendes...|
+--------------------+--------------------+----------+----------+----------+--------------------+------+--------------------+--------------------+

Write example

val df = /*
Dataframe with the following schema: 

- kind: String ... OSDU record kind. e.g. osdu:wks:master-data--GeoPoliticalEntity:1.0.0
- acl
-- viewers: Array[String] ... e.g. ["[email protected]"]
-- owners:  Array[String] ... e.g. ["[email protected]"]
- legal
-- legaltags: Array[String] ... e.g. ["opendes-publis-usa-check-1"]
-- otherRelevantDataCountries: Array[String] ... e.g. ["US"]
- data
-- !!! structure needs to match the schema defined by the reference OSDU record <kind> !!!
*/

df.write
  .format("com.microsoft.spark.osdu")
  .mode("append")
  .option("kind", "<insert-kind>") // e.g. osdu:wks:master-data--GeoPoliticalEntity:1.0.0
  .option("osduApiEndpoint", osduApiEndpoint)
  .option("partitionId", partitionId)
  .option("bearerToken", getBearerToken)
  .save()

Dev

To run the sandbox run

cd spark-datasource
sbt testOnly 

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

osdu-spark's Issues

Support Spark Streaming

Support multiple Spark/Scala versions