Giter Club home page Giter Club logo

scio-idea-plugin's Introduction

Scio IDEA plugin

Build Status GitHub license

Scio plugin for IDEA, enables BigQuery macro support in IDEA.

Raison d'être

Due to issue SCL-8834 case classes generated by @BigQueryType.fromTable or @BigQueryType.fromQuery etc, are not recognized in IntelliJ IDEA. This plugin exists to mitigate this issue. Should SCL-8834 get fixed, this plugin should be obsolete.

Install

Inside IntelliJ, Preferences -> Plugins -> Browse repositories ... and search Scio.

Build locally:

sbt packagePlugin

Zipped and ready to install plugin is inside target. To install, inside IntelliJ: Preferences -> Plugins -> Install plugin from disk

Usage

Install following instructions above. Plugin should work out of the box.

BigQuery location

If you get the location (EU/US) error - you need to add location setting to scala compiler in your IntelliJ. The easiest way is to click on the weird looking "clock" in the bottom-right corner - it's actually a shortcut to scala compiler. If it's already running - stop it, then press Configure... and in JVM parameters add -Dbigquery.staging_dataset.location=EU.

You should upgrade Scio to version >= 0.2.1 - starting from that version bigquery.staging_dataset.location is obsolete.

User interaction

If Scio plugin can't find scala files, it will log an error via IntelliJ Event Log, which you should see via red bubble in the lower-right corner. The message should inform you that, you need to recompile the project. Follow the instructions.

If you rebuild the project, plugin should react in a matter of seconds - if completion is still not there, poke the code around, wait a minute or two. At this point plugin simply reacts to IntelliJ events, which sporadically take a while to propagate.

Logging

This pluging uses IDEA diagnostic logger, you can find log files under standard IntelliJ directory (doc). For example for macOS: ~/Library/Logs/<PRODUCT><VERSION>/idea.log.

If there is error level message logged, it will show up in IntelliJ Event Log.

License

Copyright 2019 Spotify AB.

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

scio-idea-plugin's People

Contributors

scala-steward avatar regadas avatar nevillelyh avatar i-maravic avatar kant avatar mattiapiccinetti avatar ravwojdyla avatar f-loris avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.