Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EXAMPLE]: How to add new a dialect tutorial #219

Open
wants to merge 15 commits into
base: master
from

Conversation

@mtxr
Copy link
Owner

commented May 8, 2019

How to add a new dialect

Hi future contributor!

This PR is an example of how to add new dialects to the extension.

Click Files changed to see the changes you need to do to add your dialect.

In case you need help, open an issue and I'll be happy to assist you!

Good luck and welcome aboard!

To-do's

See the comments below to find the references on files.

Steps:

  • Step 1. Define dialect queries
  • Step 2. Create dialect connection file
  • Step 3. Make it available for usage
    • Step 3.1. Make it available for usage and searchable on market place
    • Step 3.2. Make it available for settings screen
  • Step 4. Create the docs and update references

After that, just submit your PR!

@project-bot project-bot bot added this to In progress in Kanban May 8, 2019

mtxr added some commits May 8, 2019

@mtxr mtxr moved this from In progress to To be released in Kanban May 8, 2019

@mtxr mtxr removed this from To be released in Kanban May 8, 2019

@mtxr mtxr changed the title EXAMPLE: How to add new a dialect tutorial EXAMPLE: How to add new a dialect tutorial (WIP) May 8, 2019

Repository owner deleted a comment from codeclimate bot May 8, 2019

Repository owner deleted a comment from codeclimate bot May 8, 2019

Repository owner deleted a comment from codecov bot May 8, 2019

Repository owner deleted a comment from codeclimate bot May 8, 2019

@@ -0,0 +1,61 @@
import { DialectQueries } from '@sqltools/core/interface';

This comment has been minimized.

Copy link
@mtxr

mtxr May 8, 2019

Author Owner

Step 1. Define dialect queries

@@ -0,0 +1,142 @@
/**

This comment has been minimized.

Copy link
@mtxr

mtxr May 8, 2019

Author Owner

Step 2. Create dialect connection file

@@ -3,13 +3,15 @@ import MySQL from './mysql';
import OracleDB from './oracle';
import PostgreSQL from './pgsql';
import SQLite from './sqlite';
import ExampleDialect from './example-dialect';

This comment has been minimized.

Copy link
@mtxr

mtxr May 8, 2019

Author Owner

Step 3. Make it available for usage

@@ -445,7 +446,8 @@
"MySQL",
"OracleDB",
"PostgreSQL",
"SQLite"

This comment has been minimized.

Copy link
@mtxr

mtxr May 8, 2019

Author Owner

Step 3.1. Make it available for usage and searchable on market place

@@ -51,6 +51,13 @@ const availableDialects = {
showHelperText: true,
requirements,
},
// add your dialect here

This comment has been minimized.

Copy link
@mtxr

mtxr May 8, 2019

Author Owner

Step 3.2. Make it available for settings screen

@@ -0,0 +1,25 @@
# Example Dialect Start Guide

This comment has been minimized.

Copy link
@mtxr

mtxr May 8, 2019

Author Owner

Step 4. Create the docs and update references

Repository owner deleted a comment from codecov bot May 8, 2019

Repository owner deleted a comment from codeclimate bot May 8, 2019

@mtxr mtxr referenced this pull request May 11, 2019

Closed

WIP: Impala queries #138

@mtxr mtxr changed the title EXAMPLE: How to add new a dialect tutorial (WIP) [EXAMPLE]: How to add new a dialect tutorial May 19, 2019

@mtxr mtxr added the tutorial label May 19, 2019

mtxr added some commits May 19, 2019

Repository owner deleted a comment from codeclimate bot May 19, 2019

Repository owner deleted a comment from codeclimate bot May 19, 2019

Repository owner locked as off topic and limited conversation to collaborators May 19, 2019

Repository owner deleted a comment from codecov bot May 19, 2019

@mtxr mtxr self-assigned this May 19, 2019

ClodoaldoPinto and others added some commits May 22, 2019

Update README.md
Typo

mtxr added some commits May 23, 2019

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
2 participants
You can’t perform that action at this time.