ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dmitriy Setrakyan <dsetrak...@apache.org>
Subject Re: sql documentation
Date Fri, 20 Oct 2017 05:01:18 GMT
Denis,

Awesome work and great contribution!

A minor comment. Does SELECT belong under DML?

D.


On Thu, Oct 19, 2017 at 6:36 PM, Denis Magda <dmagda@apache.org> wrote:

> Igniters,
>
> I’m glad to share that the new SQL doc is ready for proof read:
> https://apacheignite-sql.readme.io/docs
>
> Main sections:
> - Overview - SQL capabilities outline and getting started guide.
> - SQL Reference - SQL itself with all the commands and operations.
> - Architecture - insights on how SQL engine works and some of its features.
> - JDBC
> - ODBC
> - Tools and Analytics - tools to work with Ignite as with SQL database.
> -  Java Dev Guide - Java specific features
> - .NET Dev Guide - .NET specific features
> - C++ Dev Guide - C++ specific features
>
> Note, that all the SQL related pages will be hidden (consider removed) on
> Java, .NET and C++ readme.io sites in 2.3. All the SQL related
> capabilities have to be documented on this new specific doc.
>
> Here is we’re tracking minor documentation tasks to close before the
> release:
> https://issues.apache.org/jira/browse/IGNITE-6685
>
> Many thanks to Sergey Puchnin for the help with SQL reference
> documentation!
>
> —
> Denis
>
>
> > On Sep 14, 2017, at 5:00 AM, Serge Puchnin <sergey.puchnin@gmail.com>
> wrote:
> >
> > Denis,
> > Thanks a lot for the link.
> > It's very helpful to split "function part" to more specific like
> 'string',
> > 'numeric', etc.
> >
> > the main reason to separate "Java Developer" as an independent part
> because
> > it's about a mix between Java and SQL code.
> > It's about classes, methods, annotation, GC, etc.
> > It doesn't fully belong to the SQL specification but IMHO should be in
> SQL
> > category.
> >
> > BR,
> > Serge
> >
> > On Wed, 13 Sep 2017 at 22:39, Denis Magda <dmagda@apache.org> wrote:
> >
> >> Serge,
> >>
> >> I like the proposed format. It reminds me the one chosen by MemSQL which
> >> is crystal clear:
> >> https://docs.memsql.com/sql-reference/v5.8/sql-reference-overview/
> >>
> >> Not 100% sure about “Java Developer Guides” section. Let me contemplate
> a
> >> bit and propose other solutions.
> >>
> >> —
> >> Denis
> >>
> >> On Sep 13, 2017, at 3:41 AM, Serge Puchnin <sergey.puchnin@gmail.com>
> >> wrote:
> >>
> >> I have done some reorganizing for the SQL documentation.
> >> Thanks a lot for the review and proof read.
> >>
> >>
> >>
> >> On Wed, 13 Sep 2017 at 01:22, Dmitriy Setrakyan <dsetrakyan@apache.org>
> >> wrote:
> >>
> >>> Thanks Sergey, I think we should add SQL Syntax section on the left.
> Also,
> >>> please let us know when we can proof read it. I would like to fix some
> >>> phrasing on the page.
> >>>
> >>> On Tue, Sep 12, 2017 at 8:26 AM, Serge Puchnin <
> sergey.puchnin@gmail.com>
> >>> wrote:
> >>>
> >>>> I've added a page for SQL language, create index statement and Upper
> >>>> function as an example for the new format:
> >>>>
> >>>> https://apacheignite-sql.readme.io/v2.1/docs/create-index
> >>>>
> >>>>
> >>>>
> >>>> For me, it'd be OK to add a separate page for each SQL statement.
> >>>>
> >>>>
> >>>> BR,
> >>>>
> >>>> Serge
> >>>>
> >>>> On Sat, 9 Sep 2017 at 02:19, Denis Magda <dmagda@apache.org> wrote:
> >>>>
> >>>>> Please check you inbox.
> >>>>>
> >>>>> —
> >>>>> Denis
> >>>>>
> >>>>>> On Sep 8, 2017, at 3:38 PM, Dmitriy Setrakyan <
> >>> dsetrakyan@apache.org>
> >>>>> wrote:
> >>>>>>
> >>>>>> Denis,
> >>>>>>
> >>>>>> Can you please add me as an admin to that site?
> >>>>>>
> >>>>>> D.
> >>>>>>
> >>>>>> On Fri, Sep 8, 2017 at 3:23 PM, Denis Magda <dmagda@apache.org>
> >>> wrote:
> >>>>>>
> >>>>>>> Igniter (especially those who are willing to work on the
new SQL
> >>> doc),
> >>>>>>>
> >>>>>>> The doc for SQL capabilities has been set up. Copy pasted
all the
> >>> SQL
> >>>>>>> materials we have there:
> >>>>>>> https://apacheignite-sql.readme.io/docs <https://apacheignite-sql.
> >>>>>>> readme.io/docs>
> >>>>>>>
> >>>>>>> Sergey P., feel free to start reworking the doc according
to the
> >>> new
> >>>>>>> proposed format. Don’t hesitate removing outdating or
misleading
> >>>>> content.
> >>>>>>> If you’re uncertain about something just send us a message
here.
> >>>>>>>
> >>>>>>> Presently the doc is not indexed by searching engines. Let’s
> >>> finish it
> >>>>>>> first and announce afterwards.
> >>>>>>>
> >>>>>>> —
> >>>>>>> Denis
> >>>>>>>
> >>>>>>>> On Aug 30, 2017, at 5:43 PM, Dmitriy Setrakyan <
> >>>> dsetrakyan@apache.org>
> >>>>>>> wrote:
> >>>>>>>>
> >>>>>>>> On Wed, Aug 30, 2017 at 10:04 PM, Denis Magda <dmagda@apache.org>
> >>>>> wrote:
> >>>>>>>>
> >>>>>>>>> Serge,
> >>>>>>>>>
> >>>>>>>>> Undoubtedly, I like this format. I’ve created
a new documentation
> >>>>> domain
> >>>>>>>>> for all our SQL capabilities:
> >>>>>>>>> https://apacheignite-sql.readme.io/docs <
> >>> https://apacheignite-sql.
> >>>>>>>>> readme.io/docs>
> >>>>>>>>>
> >>>>>>>>> Once I get an open source license for it we can
start moving the
> >>>>>>> existing
> >>>>>>>>> docs and create the new there.
> >>>>>>>>>
> >>>>>>>>
> >>>>>>>> Sounds good. We should make sure that we do not "move"
the
> >>>>> documentation,
> >>>>>>>> we should "copy" it. Otherwise we will get 404 errors
in google.
> >>>>>>>>
> >>>>>>>>
> >>>>>>>>>
> >>>>>>>>> —
> >>>>>>>>> Denis
> >>>>>>>>>
> >>>>>>>>>> On Aug 30, 2017, at 4:38 AM, Serge Puchnin n
<
> >>>>> sergey.puchnin@gmail.com
> >>>>>>>>
> >>>>>>>>> wrote:
> >>>>>>>>>>
> >>>>>>>>>> Sorry for inconvenience!
> >>>>>>>>>> there is a link for a sample:
> >>>>>>>>>> https://drive.google.com/open?id=0B-s4Ivq-
> >>>>>>> lrPobzZ4c2Y1X1ZLcWhGenE4TllVM3
> >>>>>>>>> VlODhtT2Iw
> >>>>>>>>>>
> >>>>>>>>>> Serge
> >>>>>>>>>>
> >>>>>>>>>>> On 29 Aug 2017, at 19:30, Denis Magda <dmagda@apache.org>
> >>> wrote:
> >>>>>>>>>>>
> >>>>>>>>>>> Serge,
> >>>>>>>>>>>
> >>>>>>>>>>> The attachment is missing. Try to share
it via google drive or
> >>>> other
> >>>>>>>>> storage.
> >>>>>>>>>>>
> >>>>>>>>>>> —
> >>>>>>>>>>> Denis
> >>>>>>>>>>>
> >>>>>>>>>>>> On Aug 29, 2017, at 2:38 AM, Serge Puchnin
<
> >>>>> sergey.puchnin@gmail.com
> >>>>>>>>
> >>>>>>>>> wrote:
> >>>>>>>>>>>>
> >>>>>>>>>>>> Hi !
> >>>>>>>>>>>>
> >>>>>>>>>>>> As I can see, there is some room for
documentation
> >>> improvement.
> >>>>>>>>>>>> As a sample of documentation, I've prepared
a description of
> >>>>> "CREATE
> >>>>>>>>> INDEX" statement.
> >>>>>>>>>>>>
> >>>>>>>>>>>> What’s your opinion?
> >>>>>>>>>>>> What can be improved?
> >>>>>>>>>>>> What should be added?
> >>>>>>>>>>>>
> >>>>>>>>>>>> Thanks a lot!
> >>>>>>>>>>>>
> >>>>>>>>>>>> ---
> >>>>>>>>>>>> Serge
> >>>>>>>>>>>
> >>>>>>>>>
> >>>>>>>>>
> >>>>>>>
> >>>>>>>
> >>>>>
> >>>>>
> >>>>
> >>>
> >>
> >>
>
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message