Docs for jdbc interpreter #661

vgmartinez · 2016-01-20T12:12:37Z

What is this PR for?

Docs for jdbc interpreter

What type of PR is it?

Documentation

Todos

Is there a relevant Jira issue?

No. But there is related PR: https://issues.apache.org/jira/browse/ZEPPELIN-614

How should this be tested?

Screenshots (if appropriate)

Questions:

Does the licenses files need update? No
Is there breaking changes for older versions? No
Does this needs documentation? No

vgmartinez · 2016-01-20T12:13:26Z

@jongyoul please review and feel free to comment

felixcheung · 2016-01-21T00:55:27Z

docs/interpreter/jdbc.md

could we add this as a code block so that an user can copy/paste it?

vgmartinez · 2016-01-22T17:29:17Z

thanks @felixcheung....It is much better now

felixcheung · 2016-01-22T23:39:21Z

thx, you might have forgotten to take out images replaced with text from this PR?

vgmartinez · 2016-01-22T23:57:19Z

I'm sorry....;)

felixcheung · 2016-01-24T00:39:15Z

@vgmartinez thanks, but to clarify, I think it's fine that you have images to show results along with the code that can be pasted.

As of now though, you have image files such as jdbc-interpreter-use.png in this PR, but they are not referenced in jdbc.md? I'd suggest removing these from this commit/PR:

docs/assets/themes/zeppelin/img/docs-img/jdbc-interpreter-multiple-jars.png
docs/assets/themes/zeppelin/img/docs-img/jdbc-interpreter-multiple-settings.png
docs/assets/themes/zeppelin/img/docs-img/jdbc-interpreter-simple-jar.png
docs/assets/themes/zeppelin/img/docs-img/jdbc-interpreter-simple-setting.png
docs/assets/themes/zeppelin/img/docs-img/jdbc-interpreter-use.png

vgmartinez · 2016-01-24T00:45:38Z

ok...it ready now...

felixcheung · 2016-01-24T00:56:13Z

docs/interpreter/jdbc.md

oh sorry, I've missed this - please update the text as shown in the image since there is no image now?

felixcheung · 2016-01-24T00:57:54Z

pending some text issues, assuming these are fixed, this looks good.
merging if there is no more discussion, thanks.

vgmartinez · 2016-01-24T13:45:17Z

Done

AhyoungRyu · 2016-01-24T14:58:08Z

Hi @vgmartinez, thank you for a new JDBC interpreter and the docs! : )
If you want to add a docs for new interpreter, you have to provide a link for it.
Please add <li><a href="{{BASE_PATH}}/interpreter/jdbc.html">JDBC</a></li> below this line.

vgmartinez · 2016-01-24T15:35:55Z

Hi @AhyoungRyu....It done
thank for review...

Leemoonsoo · 2016-01-24T21:40:49Z

Thanks @vgmartinez for the documentation.
LGTM

corneadoug · 2016-01-25T00:01:38Z

docs/interpreter/jdbc.md

Isn't that part really similar to the previous configurations tables?

corneadoug · 2016-01-25T00:04:46Z

One question about that interpreter, how do you specify the database you want to use?

felixcheung · 2016-01-26T05:55:09Z

It depends on the type, but database name is normally part of the jdbc url: https://www.petefreitag.com/articles/jdbc_urls/

maybe we should show some example in the doc.

corneadoug · 2016-01-26T06:53:29Z

Yes it would be better to have it documented then.
So, that means you need to create a different interpreter configuration for each database you want to query.
Could we use multiple interpreter configuration in the same notebook?

vgmartinez · 2016-01-26T08:22:32Z

Hi @corneadoug,
Yes, you need create a diferent configurations for each db you use....and you can use multiple configuration in the same notebook this way:

corneadoug · 2016-01-26T08:32:46Z

@vgmartinez where is postgres coming from inside jdbc(postgres)?
Is it the name used to create the interpreter in the interpreter tab?

vgmartinez · 2016-01-26T08:38:46Z

To create the configuration is like this:

its similar to create a profile o env....

corneadoug · 2016-01-26T08:58:51Z

To me there is still plenty of things missing in the doc:

Database part is not mentioned anywhere (it seems it is part of the url)
The connections are grouped by environments where everyone can be the same type or different So you could have multiple postgres configurations? And choose which one to use (which DB)
specify the parameters for grouped environments How do you know the group environment name?
The most common properties are as follows So there might be more? Where could you see the others? Would they be listed by default?
If you want to use other connection you should specify the name of it where do you find those names?

vgmartinez · 2016-01-26T09:04:43Z

now I'm busy at work in 1 to 2 days to complete it....thanks for review

corneadoug · 2016-01-26T09:06:42Z

No problem

vgmartinez · 2016-02-04T14:49:36Z

@felixcheung @corneadoug ready to review...I think it is ready...

corneadoug · 2016-02-04T17:22:30Z

@vgmartinez I liked the improvements, that was easy to read and self-explanatory.

Just a couple of questions about the JDBC interpreter:

Is it possible to connect to 2 different databases in the same interpreter? (MySQL Server1/DB1 and MySQL Server1/DB2)
How is the prefix defined?

change bad name in property

vgmartinez · 2016-02-04T17:37:39Z

Hi @corneadoug,

yes, you can.

name	value
common.max_count	1000
prefix1.driver	org.mysql.Driver
prefix1.password	`********`
prefix1.url	server1:port/db1
prefix1.user	user
prefix2.driver	org.mysql.Driver
prefix2.password	`********`
prefix2.url	server1:port/db2
prefix2.user	user

you define the prefix with any name, and to use is %jdbc(prefix1) or %jdbc(prefix2)

corneadoug · 2016-02-04T17:41:59Z

Awesome! I think its good, waiting for @felixcheung in case he sees something to change

felixcheung · 2016-02-04T21:17:01Z

docs/_includes/themes/zeppelin/_navigation.html

                <li><a href="{{BASE_PATH}}/interpreter/geode.html">Geode</a></li>
                <li><a href="{{BASE_PATH}}/interpreter/hbase.html">HBase</a></li>
                <li><a href="{{BASE_PATH}}/interpreter/hive.html">Hive</a></li>
+                <li><a href="{{BASE_PATH}}/interpreter/jdbc.html">JDBC</a></li>


you might want to move this down a line after "Ignite"? (since this is sorted)

felixcheung · 2016-02-04T21:24:08Z

couple of questions, thanks for adding more details

vgmartinez · 2016-02-04T21:47:20Z

I fixed @felixcheung...

AhyoungRyu · 2016-02-05T02:45:40Z

docs/interpreter/jdbc.md

+  </tr>
+  <tr>
+    <td>default.password</td>
+    <td>`********`</td>


Hi @vgmartinez. Thank you for your effort to JDBC docs : )

If you purposed a code block for ********, you have to use <code> tag in the table tag instead of the back quatation mark . Or, it doesn't work.

felixcheung · 2016-02-06T19:06:18Z

Thanks, please fix and we should merge this unless anyone has more comment.

vgmartinez · 2016-02-07T11:58:46Z

It's fixed @felixcheung

felixcheung · 2016-02-08T03:36:04Z

Thanks could you see this comment #661 (comment)
and this comment #661 (comment)
too?

vgmartinez · 2016-02-08T08:32:10Z

@felixcheung @AhyoungRyu
sorry had not see those comments ... I'm a little distracted....

felixcheung · 2016-02-08T22:46:22Z

@vgmartinez sorry, i think my comment has confused you.
Please change this line
to
It is not necessary to add driver jar to the classpath for PostgreSQL as it is included in Zeppelin.

vgmartinez · 2016-02-08T23:26:05Z

Fix

felixcheung · 2016-02-09T00:16:41Z

thanks, merging if no more discussion.

jongyoul · 2016-02-09T05:21:57Z

LGTM

AhyoungRyu · 2016-02-09T05:30:10Z

LGTM : )

Docs for jdbc interpreter Documentation No. But there is related PR: https://issues.apache.org/jira/browse/ZEPPELIN-614 Does the licenses files need update? No Is there breaking changes for older versions? No Does this needs documentation? No Author: Victor Manuel <viktor.manuel.garcia@gmail.com> Author: vgmartinez <viktor.manuel.garcia@gmail.com> Closes apache#661 from vgmartinez/generic_jdbc_docs and squashes the following commits: f9cf476 [Victor Manuel] Fix comment cee96a6 [Victor Manuel] fix docs and add more details cd60020 [Victor Manuel] delete parentheses... d92d7d8 [Victor Manuel] add default prefix in simple connection b973022 [Victor Manuel] change order in link f9f194e [Victor Manuel] Update jdbc.md e3653ba [vgmartinez] fix dead link 38ccefb [vgmartinez] docs for jdbc

felixcheung reviewed Jan 21, 2016
View reviewed changes

docs/interpreter/jdbc.md Outdated

Copy link

Member

felixcheung Jan 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we add this as a code block so that an user can copy/paste it?

vgmartinez force-pushed the generic_jdbc_docs branch from ce45c58 to 5f0d120 Compare January 22, 2016 17:28

felixcheung reviewed Jan 24, 2016
View reviewed changes

corneadoug reviewed Jan 25, 2016
View reviewed changes

docs/interpreter/jdbc.md Outdated

Copy link

Contributor

corneadoug Jan 25, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't that part really similar to the previous configurations tables?

docs for jdbc

38ccefb

vgmartinez force-pushed the generic_jdbc_docs branch from b3ec52b to 38ccefb Compare February 4, 2016 14:39

fix dead link

e3653ba

Update jdbc.md

f9f194e

change bad name in property

felixcheung reviewed Feb 4, 2016
View reviewed changes

vgmartinez added 2 commits February 4, 2016 22:43

change order in link

b973022

add default prefix in simple connection

d92d7d8

AhyoungRyu reviewed Feb 5, 2016
View reviewed changes

delete parentheses...

cd60020

fix docs and add more details

cee96a6

Fix comment

f9cf476

asfgit closed this in 1bdf1ff Feb 10, 2016

Docs for jdbc interpreter #661

Docs for jdbc interpreter #661

Uh oh!

Conversation

vgmartinez commented Jan 20, 2016

What is this PR for?

What type of PR is it?

Todos

Is there a relevant Jira issue?

How should this be tested?

Screenshots (if appropriate)

Questions:

Uh oh!

vgmartinez commented Jan 20, 2016

Uh oh!

felixcheung Jan 21, 2016

Choose a reason for hiding this comment

Uh oh!

vgmartinez commented Jan 22, 2016

Uh oh!

felixcheung commented Jan 22, 2016

Uh oh!

vgmartinez commented Jan 22, 2016

Uh oh!

felixcheung commented Jan 24, 2016

Uh oh!

vgmartinez commented Jan 24, 2016

Uh oh!

felixcheung Jan 24, 2016

Choose a reason for hiding this comment

Uh oh!

felixcheung commented Jan 24, 2016

Uh oh!

vgmartinez commented Jan 24, 2016

Uh oh!

AhyoungRyu commented Jan 24, 2016

Uh oh!

vgmartinez commented Jan 24, 2016

Uh oh!

Leemoonsoo commented Jan 24, 2016

Uh oh!

corneadoug Jan 25, 2016

Choose a reason for hiding this comment

Uh oh!

corneadoug commented Jan 25, 2016

Uh oh!

felixcheung commented Jan 26, 2016

Uh oh!

corneadoug commented Jan 26, 2016

Uh oh!

vgmartinez commented Jan 26, 2016

Uh oh!

corneadoug commented Jan 26, 2016

Uh oh!

vgmartinez commented Jan 26, 2016

Uh oh!

corneadoug commented Jan 26, 2016

Uh oh!

vgmartinez commented Jan 26, 2016

Uh oh!

corneadoug commented Jan 26, 2016

Uh oh!

vgmartinez commented Feb 4, 2016

Uh oh!

corneadoug commented Feb 4, 2016

Uh oh!

vgmartinez commented Feb 4, 2016

Uh oh!

corneadoug commented Feb 4, 2016

Uh oh!

felixcheung Feb 4, 2016

Choose a reason for hiding this comment

Uh oh!

felixcheung commented Feb 4, 2016

Uh oh!

vgmartinez commented Feb 4, 2016

Uh oh!

AhyoungRyu Feb 5, 2016

Choose a reason for hiding this comment

Uh oh!