[jira] [Commented] (IGNITE-4018) DML: Add documentation to Apache Ignite Readme.io

["Denis Magda (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/IGNITE-4018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15710351#comment-15710351 ] 

Denis Magda commented on IGNITE-4018:
-------------------------------------

[~al.psc], I've briefly looked over the current documentation [1] and have a minor note.

Instead of providing raw SQL code snippets like the one below

{code} 
merge into Person(_key, first_name, second_name) values
  (1, "John", "Smith"),
  (5, "Mary", "Jones")
{code}

please use our Java SQL API instead like it's done over there [2] for SELECT queries code snippets.

In addition, as it mentioned in the ticket description, please add a DML related section into JDBC documentation [3]. The section simply should include code snippets for UPDATE, INSERT and DELETE queries executed using a JDBC connection. A good example of how the section should look like is shown on a similar ODBC documentation page [4].

[1] https://apacheignite.readme.io/docs/distributed-dml#dml-operations
[2] https://apacheignite.readme.io/docs/sql-queries#cross-cache-queries
[3] https://apacheignite.readme.io/docs/jdbc-driver
[4] https://apacheignite.readme.io/docs/querying-and-modifying-data#inserting-data

> DML: Add documentation to Apache Ignite Readme.io
> -------------------------------------------------
>
>                 Key: IGNITE-4018
>                 URL: https://issues.apache.org/jira/browse/IGNITE-4018
>             Project: Ignite
>          Issue Type: Task
>          Components: documentation, SQL
>            Reporter: Denis Magda
>            Assignee: Alexander Paschenko
>            Priority: Critical
>             Fix For: 1.8
>
>
> In Apache Ignite 1.8 the community is planning to release DML support.
> To adopt DML usage we need to add documentation about the feature.
> Let's create a new page for now named DML and place it under SQL Queries page [1] in the menu. The content should be the following:
> - Basic overview.
> - Description of INSERT, UPDATE, MERGE commands with code snippet examples.
> - There should be paragraphs saying that it's supported by our JDBC and ODBC drivers (refer to the relevant ODBC page's section IGNITE-4019).
> - As a part of this ticket add a section to existed JDBC Driver page [2] describing that it works over the driver as well. Provide a code snippet example. Refer to this section from the main DML page.
> The page should be hidden until 1.8 gets released. Once you've done assign the ticket to [~pgarg] for polishing and review.
> [1] https://apacheignite.readme.io/docs/sql-queries
> [2] https://apacheignite.readme.io/docs/jdbc-driver



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)