Created the initial version of the Trafodion Messages Manual. Fixed broken links between different manuals.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/e77d8018 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/e77d8018 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/e77d8018 Branch: refs/heads/master Commit: e77d8018e6339579ddf62dfaf38be67938e4c829 Parents: 6201356 Author: Gunnar Tapper <[email protected]> Authored: Thu Jan 21 17:34:29 2016 -0700 Committer: Gunnar Tapper <[email protected]> Committed: Thu Jan 21 17:34:29 2016 -0700 ---------------------------------------------------------------------- .../src/asciidoc/_chapters/introduction.adoc | 6 +- .../src/asciidoc/_chapters/commands.adoc | 6 +- .../src/asciidoc/_chapters/interactive.adoc | 10 +- .../src/asciidoc/_chapters/scripts.adoc | 2 +- .../src/asciidoc/_chapters/requirements.adoc | 48 +- docs/messages_guide/pom.xml | 279 ++ .../src/asciidoc/_chapters/about.adoc | 180 + .../src/asciidoc/_chapters/binder_msgs.adoc | 2906 ++++++++++++++++ .../src/asciidoc/_chapters/compiler_msgs.adoc | 1549 +++++++++ .../src/asciidoc/_chapters/ddl_msgs.adoc | 3047 ++++++++++++++++ .../src/asciidoc/_chapters/executor_msgs.adoc | 935 +++++ .../asciidoc/_chapters/file_system_errors.adoc | 529 +++ .../src/asciidoc/_chapters/generator_msgs.adoc | 59 + .../src/asciidoc/_chapters/introduction.adoc | 116 + .../src/asciidoc/_chapters/optimizer_msgs.adoc | 118 + .../src/asciidoc/_chapters/parser_msgs.adoc | 3273 ++++++++++++++++++ .../src/asciidoc/_chapters/sort_msgs.adoc | 504 +++ .../src/asciidoc/_chapters/sqlstate.adoc | 2111 +++++++++++ .../_chapters/udr_language_mgr_msgs.adoc | 112 + docs/messages_guide/src/asciidoc/index.adoc | 73 + .../src/asciidoc/_chapters/about.adoc | 2 +- .../src/asciidoc/_chapters/sql_statements.adoc | 10 +- .../src/asciidoc/_chapters/sql_utilities.adoc | 2 +- 23 files changed, 15857 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/e77d8018/docs/client_install/src/asciidoc/_chapters/introduction.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/_chapters/introduction.adoc b/docs/client_install/src/asciidoc/_chapters/introduction.adoc index cd577ab..c347335 100644 --- a/docs/client_install/src/asciidoc/_chapters/introduction.adoc +++ b/docs/client_install/src/asciidoc/_chapters/introduction.adoc @@ -2,7 +2,7 @@ /** *@@@ START COPYRIGHT @@@ * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file + * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the @@ -38,9 +38,9 @@ Trafodion database. NOTE: The Trafodion Command Interface (TrafCI), DbVisualizer, and SQuirreL SQL Client require this driver to be installed on the client workstation. | Trafodion Command Interface (TrafCI) | A command-line interface that allows you to connect to a Trafodion database and run SQL statements and other commands interactively or from -script files. For more information, see the http://trafodion.incubator.apache.org/command_interface/index.html[_Trafodion Command Interface Guide_]. +script files. For more information, see the http://trafodion.incubator.apache.org/docs/command_interface/index.html[_Trafodion Command Interface Guide_]. | Trafodion odb tool | A multi-threaded, ODBC-based command-line tool for parallel data loading and extracting. For more information, see the -http://trafodion.incubator.apache.org/odb_user/index.html[_Trafodion odb User Guide_]. +http://trafodion.incubator.apache.org/docs/odb_user/index.html[_Trafodion odb User Guide_]. | DbVisualizer | A third-party database tool that allows you to connect to a Trafodion database. For more information, see the http://www.dbvis.com/[_DbVisualizer website_]. | SQuirreL SQL Client | A third-party database tool that allows you to connect to a Trafodion database. For more information, see the http://squirrel-sql.sourceforge.net/[_SQuirreL SQL Client website_]. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/e77d8018/docs/command_interface/src/asciidoc/_chapters/commands.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/commands.adoc b/docs/command_interface/src/asciidoc/_chapters/commands.adoc index 24bc7e4..6ea12f6 100644 --- a/docs/command_interface/src/asciidoc/_chapters/commands.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/commands.adoc @@ -2645,7 +2645,7 @@ The parameter name and value are associated with one of these parameter types: A prepared statement is one that you SQL compile by using the PREPARE statement. For more information about PREPARE, see the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. After running `SET PARAM` commands in the session: @@ -2655,7 +2655,7 @@ After running `SET PARAM` commands in the session: that contains literal values and/or a list of the named parameters set by `SET PARAM`. The `EXECUTE` statement substitutes parameter values for the parameters in the prepared statement. For more information about `EXECUTE`, see the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. <<< === Syntax @@ -3046,7 +3046,7 @@ SQL> ``` For more information on the STATISTICS command, see the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. <<< [[cmd_set_time]] http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/e77d8018/docs/command_interface/src/asciidoc/_chapters/interactive.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/interactive.adoc b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc index 8c85560..adf237c 100644 --- a/docs/command_interface/src/asciidoc/_chapters/interactive.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc @@ -51,7 +51,7 @@ You can continue any SQL statement over multiple lines, breaking that statement within a word, a numeric literal, or a multicharacter operator (for example, `<=`). To break a string literal in a DML statement, use a concatenation operator (`||`). For more information, see the concatenation operator in the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. To terminate an SQL statement that spans multiple lines, use the SQL terminator for the session. You can also include several SQL statements on the same command line provided that each one is @@ -303,7 +303,7 @@ the schema in a script file, reset the default schema for the session at the end file. For more information about the SET SCHEMA statement, see the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. The `SHOW SCHEMA` command displays the current schema for the session. @@ -445,7 +445,7 @@ For more information, see the <<cmd_help, HELP Command>>. In TrafCI, you can run SQL statements interactively. TrafCI supports all the SQL statements, SQL utilities, and other SQL-related commands that the Trafodion database engine supports. For more information about those SQL statements, see the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. To run SQL statements from script files in TrafCI, see <<run_scripts, Run Scripts>>. @@ -583,7 +583,7 @@ SQL> PREPARE empcom FROM ``` For the syntax of the PREPARE statement, see the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. [[interactive_set_parameters]] ==== Setting Parameters @@ -787,7 +787,7 @@ SQL> ``` For the syntax of the EXECUTE statement, see the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. <<< [[interactive_log_output]] http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/e77d8018/docs/command_interface/src/asciidoc/_chapters/scripts.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/scripts.adoc b/docs/command_interface/src/asciidoc/_chapters/scripts.adoc index 7d9176f..9c70f7e 100644 --- a/docs/command_interface/src/asciidoc/_chapters/scripts.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/scripts.adoc @@ -45,7 +45,7 @@ that run TrafCI, see <<perl_or_python, Run TrafCI from Perl or Python>>. Script files support any of the various SQL statements that you can run in TrafCI. For more information about SQL statements, see the -http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. [[script_commands]] == Commands http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/e77d8018/docs/install_guide/src/asciidoc/_chapters/requirements.adoc ---------------------------------------------------------------------- diff --git a/docs/install_guide/src/asciidoc/_chapters/requirements.adoc b/docs/install_guide/src/asciidoc/_chapters/requirements.adoc index 47bd024..b88f46d 100644 --- a/docs/install_guide/src/asciidoc/_chapters/requirements.adoc +++ b/docs/install_guide/src/asciidoc/_chapters/requirements.adoc @@ -47,4 +47,50 @@ each server you will install Trafodion on: * `/etc/resolv.conf` is configured to use a name server tat can resolve commands such as `host -T <FQDN>`. Please attempt to use such a command to validate host-name resolution. * The Linux Kernel Firewall (`iptables`) has either been disabled (to check: `service iptables status` (requires sudo access) -or [ports required by Trafodion] have been opened \ No newline at end of file +or <<ip_ports,ports required by Trafodion>> have been opened + +[[ip_ports]] +=== IP Ports +The following table lists the default ports used by the different Trafodion components plus the configuration file and configuration attribute associated with each port setting. + +[cols="10%h,20%l,20%l,10%,10%,10%,20%",options="header"] +|=== +| Default Port | Configuration File | Configuration Entry | Required | Range | Protocol | Comment +| 4200 | rest-site.xml | trafodion.rest.port | Yes | 1 | REST | Trafodion REST Server. +| 4201 | rest-site.xml | trafodion.rest.https.port | Yes | 1 | HTTPS | Trafodion REST Server (HTTPS). +| 23400 | dcs-site.xml | dcs.master.port | Yes | _n_ | binary | Start of Trafodion DCS port range. (37800 for Trafodion 1.1) +| 24400 | dcs-site.xml | dcs.master.info.port | Yes | 1 | HTTP | DCS master web GUI. (40010 for Trafodion 1.1) +| 24410 | dcs-site.xml | dcs.server.info.port | Yes | _n_ | HTTP | Start of range for DCS server web GUIs. (40020 for Trafodion 1.1) +| 50030 | mapred-site.xml | mapred.job.tracker.http.address | No | 1 | HTTP | MapReduce Job Tracker web GUI. +| 50070 | hdfs-site.xml | dfs.http.address | No | 1 | HTTP | HDFS Name Node web GUI. +| 50075 | hdfs-site.xml | dfs.datanode.http.address | No | 1 | HTTP | HDFS Data Node web GUI. +| 50090 | hdfs-site.xml | dfs.secondary.http.address | No | 1 | HTTP | HDFS Secondary Name Node web GUI. +| 60010 | hbase-site.xml | hbase.master.info.port | No | 1 | HTTP | HBase Master web GUI. +| 60030 | hbase-site.xml | hbase.regionserver.info.port | No | 1 | HTTP | HBase Region Server web GUI. +|=== + +There are two port ranges used by Trafodion. + +* 23400 is a range, to allow multiple mxosrvr processes on each node. Allow a range of a few ports, +enough to cover all the servers per node that are listed in the "servers" file in the DCS configuration directory. +* 24410 is a range as well, enough to cover the DCS servers per node, usually 1 or 2. + +On top of the ports identified above, you also need the ports required by your Hadoop distribution. For example: + +* http://www.cloudera.com/content/www/en-us/documentation/enterprise/latest/topics/cdh_ig_ports_cdh5.html[_Cloudera Ports_] +* http://docs.hortonworks.com/HDPDocuments/HDP2/HDP-2.3.0-Win/bk_HDP_Install_Win/content/ref-79239257-778e-42a9-9059-d982d0c08885.1.html[_Hortonworks Ports_] + +Although not all the ports will be used on every node of the cluster, you need to open most of them for all the nodes in the cluster that +have Trafodion, HBase, or HDFS servers on them. + +== Prerequisite Software + +=== Hadoop Services + +The following Hadoop services must be running on the cluster where you install Trafodion: + + + +=== Software Packages + +You need to install the following software and dependencies before installing Trafodion. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/e77d8018/docs/messages_guide/pom.xml ---------------------------------------------------------------------- diff --git a/docs/messages_guide/pom.xml b/docs/messages_guide/pom.xml new file mode 100644 index 0000000..3de991d --- /dev/null +++ b/docs/messages_guide/pom.xml @@ -0,0 +1,279 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <!-- +* @@@ START COPYRIGHT @@@ +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +* @@@ END COPYRIGHT @@@ +--> + <modelVersion>4.0.0</modelVersion> + <groupId>org.apache.trafodion</groupId> + <artifactId>messages-guide</artifactId> + <version>1.3.0</version> + <packaging>pom</packaging> + <name>Trafodion Messages Guide</name> + <description>This guide describes user-visible messages produced by Trafodion.</description> + <url>http://trafodion.incubator.apache.org</url> + <inceptionYear>2015</inceptionYear> + + <licenses> + <license> + <name>The Apache Software License, Version 2.0</name> + <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> + <distribution>repo</distribution> + <comments>A business-friendly OSS license</comments> + </license> + </licenses> + + <organization> + <name>Apache Software Foundation</name> + <url>http://www.apache.org</url> + </organization> + + <issueManagement> + <system>JIRA</system> + <url>http://issues.apache.org/jira/browse/TRAFODION</url> + </issueManagement> + + <scm> + <connection>scm:git:http://git-wip-us.apache.org/repos/asf/incubator-trafodion.git</connection> + <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-trafodion.git</developerConnection> + <url>https://git-wip-us.apache.org/repos/asf?p=incubator-trafodion.git</url> + <tag>HEAD</tag> + </scm> + + <ciManagement> + <system>Jenkins</system> + <url>https://jenkins.esgyn.com</url> + </ciManagement> + + <properties> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + <asciidoctor.maven.plugin.version>1.5.2.1</asciidoctor.maven.plugin.version> + <asciidoctorj.pdf.version>1.5.0-alpha.10.1</asciidoctorj.pdf.version> + <asciidoctorj.version>1.5.3.2</asciidoctorj.version> + <rubygems.prawn.version>2.0.2</rubygems.prawn.version> + <jruby.version>9.0.4.0</jruby.version> + </properties> + + <repositories> + <repository> + <id>rubygems-proxy-releases</id> + <name>RubyGems.org Proxy (Releases)</name> + <url>http://rubygems-proxy.torquebox.org/releases</url> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>false</enabled> + </snapshots> + </repository> + </repositories> + + <dependencies> + <dependency> + <groupId>rubygems</groupId> + <artifactId>prawn</artifactId> + <version>${rubygems.prawn.version}</version> + <type>gem</type> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.jruby</groupId> + <artifactId>jruby-complete</artifactId> + <version>${jruby.version}</version> + </dependency> + <dependency> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj</artifactId> + <version>${asciidoctorj.version}</version> + </dependency> + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>de.saumya.mojo</groupId> + <artifactId>gem-maven-plugin</artifactId> + <version>1.0.10</version> + <configuration> + <!-- align JRuby version with AsciidoctorJ to avoid redundant downloading --> + <jrubyVersion>${jruby.version}</jrubyVersion> + <gemHome>${project.build.directory}/gems</gemHome> + <gemPath>${project.build.directory}/gems</gemPath> + </configuration> + <executions> + <execution> + <goals> + <goal>initialize</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-resources-plugin</artifactId> + <version>2.7</version> + <configuration> + <encoding>UTF-8</encoding> + <attributes> + <generateReports>false</generateReports> + </attributes> + </configuration> + </plugin> + <plugin> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctor-maven-plugin</artifactId> + <version>${asciidoctor.maven.plugin.version}</version> + <dependencies> + <dependency> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj-pdf</artifactId> + <version>${asciidoctorj.pdf.version}</version> + </dependency> + <dependency> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj</artifactId> + <version>${asciidoctorj.version}</version> + </dependency> + </dependencies> + <configuration> + <sourceDirectory>${basedir}/src</sourceDirectory> + </configuration> + <executions> + <execution> + <id>generate-html-doc</id> + <goals> + <goal>process-asciidoc</goal> + </goals> + <phase>site</phase> + <configuration> + <doctype>book</doctype> + <backend>html5</backend> + <sourceHighlighter>coderay</sourceHighlighter> + <outputDirectory>${basedir}/target/site</outputDirectory> + <requires> + <require>${basedir}/../shared/google-analytics-postprocessor.rb</require> + </requires> + <attributes> + <!-- Location of centralized stylesheet --> + <stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet> + <projectVersion>1.3.0</projectVersion> + <buildDate>${maven.build.timestamp}</buildDate> + <google-analytics-account>UA-72491210-1</google-analytics-account> + </attributes> + </configuration> + </execution> + <execution> + <id>generate-pdf-doc</id> + <phase>site</phase> + <goals> + <goal>process-asciidoc</goal> + </goals> + <configuration> + <doctype>book</doctype> + <backend>pdf</backend> + <sourceHighlighter>coderay</sourceHighlighter> + <outputDirectory>${basedir}/target</outputDirectory> + <attributes> + <pdf-stylesdir>${basedir}/../shared</pdf-stylesdir> + <pdf-style>trafodion</pdf-style> + <icons>font</icons> + <pagenums/> + <toc/> + <idprefix/> + <idseparator>-</idseparator> + </attributes> + </configuration> + </execution> + </executions> + </plugin> + <!-- Rename target/site/index.pdf to client-install-guide.pdf --> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-antrun-plugin</artifactId> + <version>1.8</version> + <inherited>false</inherited> + <executions> + <execution> + <id>populate-release-directories</id> + <phase>post-site</phase> + <configuration> + <target name="Populate Release Directories"> + <!-- The website uses the following organization for the docs/target/docs directory: + - To ensure a known location, the base directory contains the LATEST version of the web book and the PDF files. + - The know location is docs/target/docs/<document> + - target/docs/<version>/<document> contains version-specific renderings of the documents. + - target/docs/<version>/<document> contains the PDF version and the web book. The web book is named index.html + --> + <!-- Copy the PDF file to its target directories --> + <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/client_install/Trafodion_Messages_Guide.pdf" /> + <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/${project.version}/client_install/Trafodion_Messages_Guide.pdf" /> + <!-- Copy the Web Book files to their target directories --> + <copy todir="${basedir}/../target/docs/messages_guide"> + <fileset dir="${basedir}/target/site"> + <include name="**/*.*"/> <!--All sub-directories, too--> + </fileset> + </copy> + <copy todir="${basedir}/../target/docs/${project.version}/messages_guide"> + <fileset dir="${basedir}/target/site"> + <include name="**/*.*"/> <!--All sub-directories, too--> + </fileset> + </copy> + </target> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> + + <!-- Included because this is required. No reports are generated. --> + <reporting> + <excludeDefaults>true</excludeDefaults> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>2.8</version> + <reportSets> + <reportSet> + <reports> + </reports> + </reportSet> + </reportSets> + </plugin> + </plugins> + </reporting> + + <distributionManagement> + <site> + <id>trafodion.incubator.apache.org</id> + <name>Trafodion Website at incubator.apache.org</name> + <!-- On why this is the tmp dir and not trafodion.incubator.apache.org, see + https://issues.apache.org/jira/browse/HBASE-7593?focusedCommentId=13555866&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-13555866 + --> + <url>file:///tmp</url> + </site> + </distributionManagement> +</project> http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/e77d8018/docs/messages_guide/src/asciidoc/_chapters/about.adoc ---------------------------------------------------------------------- diff --git a/docs/messages_guide/src/asciidoc/_chapters/about.adoc b/docs/messages_guide/src/asciidoc/_chapters/about.adoc new file mode 100644 index 0000000..21c02c3 --- /dev/null +++ b/docs/messages_guide/src/asciidoc/_chapters/about.adoc @@ -0,0 +1,180 @@ +//// +/** +* @@@ START COPYRIGHT @@@ +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +* @@@ END COPYRIGHT @@@ + */ +//// + += About This Document +Trafodion is a relational database management system based on +ANSI SQL. It uses the industry standard Structured Query Language +(SQL) to define and manipulate data. This manual describes messages +produced by the Trafodion SQL engine and its associated +components. + +== Intended Audience +This manual was written for Trafodion database administrators and +programmers who use the Trafodion database software conversational or +programmatic interface. + +== New and Changed Information +This is a new manual. + +== Notation Conventions +This list summarizes the notation conventions for syntax presentation in this manual. + +* UPPERCASE LETTERS ++ +Uppercase letters indicate keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required. ++ +``` +SELECT +``` + +* lowercase letters ++ +Lowercase letters, regardless of font, indicate variable items that you supply. Items not enclosed in brackets are required. ++ +``` +file-name +``` + +<<< +* [ ] Brackets ++ +Brackets enclose optional syntax items. ++ +``` +DATETIME [start-field TO] end-field +``` ++ +A group of items enclosed in brackets is a list from which you can choose one item or none. ++ +The items in the list can be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. ++ +For example: ++ +``` +DROP SCHEMA schema [CASCADE] +DROP SCHEMA schema [ CASCADE | RESTRICT ] +``` + +* { } Braces ++ +Braces enclose required syntax items. ++ +``` +FROM { grantee [, grantee ] ... } +``` ++ +A group of items enclosed in braces is a list from which you are required to choose one item. ++ +The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. ++ +For example: ++ +``` +INTERVAL { start-field TO end-field } +{ single-field } +INTERVAL { start-field TO end-field | single-field } +``` +* | Vertical Line ++ +A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. +``` +{expression | NULL} +``` + +<<< +* … Ellipsis ++ +An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. ++ +``` +ATTRIBUTE[S] attribute [, attribute] ... +{, sql-expression } ... +``` ++ +An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. ++ +For example: +``` +expression-n ... +``` + +* Punctuation ++ +Parentheses, commas, semicolons, and other symbols not previously described must be typed as shown. ++ +``` +DAY (datetime-expression) +@script-file +``` ++ +Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must type as shown. ++ +For example: ++ +``` +"{" module-name [, module-name] ... "}" +``` + +<<< +* Item Spacing ++ +Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma. ++ +``` +DAY (datetime-expression) DAY(datetime-expression) +``` ++ +If there is no space between two items, spaces are not permitted. In this example, no spaces are permitted between the period and any other items: ++ +``` +myfile.sh +``` + +* Line Spacing ++ +If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by a blank line. ++ +This spacing distinguishes items in a continuation line from items in a vertical list of selections. ++ +``` +match-value [NOT] LIKE _pattern + [ESCAPE esc-char-expression] +``` + +== Publishing History +[cols="2*",options="header"] +|=== +| Product Version | Publication Date +| Trafodion Release 1.3.0 | To be announced. +|=== + +== Comments Encouraged +The Trafodion community encourages your comments concerning this document. We are committed to providing documentation that meets your +needs. Send any errors found, suggestions for improvement, or compliments to: + [email protected] + +Include the document title and any comment, error found, or suggestion for improvement you have concerning this document. +
