Skip to content

A Tool Window plugin for IntelliJ that displays Avro and Parquet files and their schemas in JSON.

License

Notifications You must be signed in to change notification settings

ai-from-70s/intellij-avro-parquet-plugin

 
 

Repository files navigation

IntelliJ Avro and Parquet Viewer Plugin

Java CI JetBrains IntelliJ plugins

Overview

A Tool Window plugin for IntelliJ that displays Avro and Parquet files and their schemas in JSON.

Features include:

  • Simple drag-and-drop interface
  • Tablulated and JSON viewing of records
  • Column sorting in table view
  • Foldable schema viewing (RSyntaxTextArea)
  • Flattening of nested records in table view (json-flattener)
  • Configurable number of records to display
  • Automatic support for IntelliJ's light and Darcula themes
  • Compatible with all IntelliJ-based products (including PyCharm and Android Studio)

Installing

Available on the IntelliJ Plugin Marketplace. Search "Avro and Parquet Viewer" in IntelliJ's Plugins window. Once installed, it will appear as a Tool Window (normally at the bottom of IntelliJ next to Run, Debug, Version Control etc.).

Demo

Gallery

Table view:

table view

Raw view:

raw view

Schema view:

schema view

Bug Reports, Feature Requests and Contributions

Raise a PR or Issue.

Building Locally

This project can be built locally and manually installed in IntelliJ. To do this:

  1. Build the project with gradlew buildPlugin,
  2. Navigate to Settings -> Plugins -> Install Plugin From Disk... and point to the zip in build/distributions.

Release Process

To release a new version of the plugin:

  1. Create a release/x.y.z branch (where the version corresponds to the version in gradle.properties::version,
  2. Update the changeNotes in build.gradle,
  3. Merge the branch into master,
  4. Create and push a tag (where x.y.z is the current project version):
    git tag -a vx.y.z -m "Create release tag vx.y.z"
    git push origin --tags
    
  5. When the tag is pushed, the "Create Release" GitHub Action will automatically run and do the following:
    1. Create a Release in GitHub,
    2. Build and upload the plugin zip to GitHub Releases,
    3. Increment the project version and commit the new version to gradle.properties and plugin.xml in master.
  6. Upload the zip to the IntelliJ Marketplace (currently only @benwatson528 has credentials).

License

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

About

A Tool Window plugin for IntelliJ that displays Avro and Parquet files and their schemas in JSON.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%