You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafodion.apache.org by db...@apache.org on 2016/05/05 23:39:32 UTC
[01/22] incubator-trafodion git commit: JDBCT$ Programmer's Reference
Guide
Repository: incubator-trafodion
Updated Branches:
refs/heads/master 5e175622f -> d79ef12ba
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc
new file mode 100644
index 0000000..632ea7e
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc
@@ -0,0 +1,959 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[type-4-driver-property-descriptions]]
+= Type 4 Driver Property Descriptions
+
+The properties are listed in alphabetic order with their descriptions.
+For the properties summarized in categories, see
+<<summary-of-type-4-driver-properties, Summary of Type 4 Driver Properties>>.
+
+////
+[[blobtablename]]
+== blobTableName Property
+
+See <<lob-table-name, LOB Table Name Properties>>.
+////
+
+[[catalog]]
+== catalog Property
+
+The `catalog` property sets the default catalog used to access SQL objects
+referenced in SQL statements if the SQL objects are not fully qualified.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object. For information about how to set
+properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: none
+```
+
+*Example*
+
+Specifying the catalog Seabase:
+
+```
+catalog=Seabase
+```
+
+////
+[[clobtablename]]
+== clobTableName Property
+
+See <<lob-table-name, LOB Table Name Properties>>.
+////
+
+<<<
+[[connectiontimeout]]
+== connectionTimeout Property
+
+The `connectionTimeout` property sets the number of seconds a connection
+can be idle before the connection is physically closed by DCS.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object. For information about how to set
+properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: int
+
+Units: seconds
+
+Default: -1 (Use the ConnTimeout value set on the server-side data source.)
+
+Range: -1, 0 to 2147483647
+```
+
+* Zero (0) specifies infinity as the timeout value.
+* A non-zero positive value overrides the value set on the
+{project-name} data source, if allowed by the connectivity settings.
+* A negative value is treated as -1.
+
+*Example*
+
+Consider the following scenario.
+
+Even if a connection is not being used, it takes up resources. The application
+abandons connections; that is, the application does not physically close a
+connection after the application finishes using the connection.
+
+However, you can configure the connection to close itself after 300 seconds by setting
+the `connectionTimeout` property. Then, when a connection is not referenced for 300 seconds,
+the connection automatically closes itself.
+
+In this example, the specification to set the `connectionTimeout` property is:
+
+```
+connectionTimeout=300
+```
+
+<<<
+[[fetchbuffersize]]
+== fetchBufferSize Property
+
+The `fetchBufferSize` property provides the benefits of bulk fetch.
+
+This property sets the value in kilobytes (KB) of the size of the fetch
+buffer that is used when rows are fetched from a `ResultSet` object after
+a successful `executeQuery()` operation on a statement.
+
+Set this property on a `DriverManager` object. For information about how to set
+properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: short
+
+Default size: 4
+
+Range: 4 through 32767
+```
+
+* Zero and negative values are treated as default values.
+* The Type 4 driver guarantees that the number of rows internally
+fetched will be no less than the minimum of the row size (set using
+the `setFetchSize` method) and the number of rows that will fit in the
+memory specified by the `setFetchSize` (set using the property).
+
+*Example*
+
+```
+fetchBufferSize=32
+```
+
+<<<
+[[initialpoolsize]]
+== initialPoolSize Property
+
+The `initialPoolSize` property sets the initial connection pool size when
+connection pooling is used with the Type 4 driver.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object. For information about how to set
+properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+The driver creates _n_ connections (where _n_ is `initialPoolSize`) for
+each connection pool when the first connection is requested. For
+example, if `initialPoolSize` is set to `5` for a data source, then the driver
+attempts to create and pool five connections the first time the
+application calls the data source's `getConnection()` method.
+
+```
+Data type: int
+
+Units: number of physical connections
+
+Default: -1 (Do not create an initial connection pool.)
+
+Range: -1 to maxPoolSize
+```
+
+* Any negative value is treated as -1.
+* Values can be less than `minPoolSize`, but must not exceed `maxPoolSize`.
+If the specified value is greater than `maxPoolSize`, the `maxPoolSize`
+property value is used.
+
+*Example*
+
+```
+initialPoolSize=10
+```
+
+<<<
+[[iso88591]]
+== ISO88591 Property
+
+The `ISO88591` character-set mapping property corresponds to the
+SQL ISO88591 character set, which is a single-byte
+8-bit character set for character data types. This property supports
+English and other Western European languages. For more information, see
+<<internationalization-support, Internationalization Support>>.
+
+Set this property on a `DataSource` object or `DriverManager` object. This
+property is ignored for connections made through the
+`ConnectionPoolDataSource` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+```
+Data type: String
+
+Default: ISO88591_1
+```
+
+The value can be any valid Java Canonical Name as listed in the
+"Canonical Name for java.io and java.lang API" column of the
+http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html[Java documentation].
+
+For more information, see
+<<internationalization-support, Internationalization Support>>.
+
+<<<
+[[kanji]]
+== KANJI Property
+
+The `KANJI` character-set mapping property corresponds to the
+SQL KANJI character set, which is a double-byte character set widely used on Japanese mainframes.
+This property is a subset of Shift JIS: the double character portion. The encoding for
+this property is big endian.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: SJIS (which is shift-JIS, Japanese)
+```
+
+*Example*
+
+```
+java -Dhpt4jdbc.KANJI=SJIS
+```
+
+For more information, see
+<<internationalization-support, Internationalization Support>>.
+
+<<<
+[[ksc5601]]
+== KSC5601 Property
+
+The `KSC5601` character-set mapping property corresponds to the
+SQL KSC5601 character set, which is a double-byte
+character set.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: ECU_KR (which is KS C 5601, ECU encoding, Korean)
+```
+
+The value can be any valid Java Canonical Name as listed in the
+"Canonical Name for java.io and java.lang API" column of the
+http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html[Java documentation].
+
+*Example*
+
+```
+java -Dhpt4jdbc.KSC5601=ECU_KR
+```
+
+For more information, see
+<<internationalization-support, Internationalization Support>>.
+
+<<<
+[[language]]
+== language Property
+
+The `language` property sets the language used for the error messages. For
+more information about using this property, see
+<<localizing-error-messages-and-status-messages, Localizing Error Messages and Status Messages>>
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: none
+```
+
+The value can be any valid Java Canonical Name as listed in the
+"Canonical Name for java.io and java.lang API" column of the
+http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html[Java documentation].
+
+*Example*
+
+To set the language to shift-JIS, Japanese:
+
+```
+language=SJIS
+```
+
+////
+[[lob-table-name]]
+== LOB Table Name Properties
+
+LOB tables store data for BLOB columns and CLOB columns. The properties
+that specify the LOB table for using BLOB columns or CLOB columns are:
+
+* For the binary data for BLOB columns `blobTableName`.
+* For the character data for CLOB columns `clobTableName`.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+The property value is of the form:
+
+```
+catalog_name.schema_name.lob_table_name
+```
+
+```
+Data type: String
+
+Default: none
+```
+
+*Example*
+
+```
+blobTableName=samdbcat.sales.lobvideo
+```
+////
+
+<<<
+[[logintimeout]]
+== loginTimeout Property
+
+The `loginTimeout` property sets the time limit that a connection can be
+attempted before the connection disconnects. When a connection is
+attempted for a period longer than the set value, in seconds, the
+connection disconnects.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: int
+
+Units: seconds
+
+Default: 60
+
+Range: 0 to 2147483647
+```
+
+If set to 0 (zero), no login timeout is specified.
+
+<<<
+[[maxidletime]]
+== maxIdleTime Property
+
+The `maxIdleTime` property determines the number of seconds that a
+physical connection should remain unused in the pool before the
+connection is closed. 0 (zero) indicates no limit.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: int
+
+Units: seconds
+
+Default: 0 (No timeout)
+
+Range: 0 through 2147483647
+```
+
+Any negative value is treated as 0, which indicates that no time limit
+applies.
+
+*Example*
+
+To set the maximum idle time to 5 minutes (300 seconds):
+
+```
+java -Dhpt4jdbc.maxIdleTime=300
+```
+
+<<<
+[[maxpoolsize]]
+== maxPoolSize Property
+
+The `maxPoolSize` property sets the maximum number of physical connections
+that the pool can contain. These connections include both free
+connections and connections in use. When the maximum number of physical
+connections is reached, the Type 4 driver throws an SQLException and
+sends the message, Maximum pool size is reached.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: int
+
+Units: number of physical connections
+
+Default: -1 (Disables connection pooling.)
+
+Range: -1, 0 through 2147483647, but greater than minPoolSize
+```
+
+The value determines connection-pool use as follows:
+
+* Any negative value is treated like -1.
+
+* 0 means no maximum pool size.
+
+* A value of -1 disables connection pooling.
+
+Any positive value less than `minPoolSize` is changed to the `minPoolSize` value.
+
+<<<
+[[maxstatements]]
+== maxStatements Property
+
+The `maxStatements` property sets the total number of `PreparedStatement`
+objects that the connection pool should cache. This total includes both
+free objects and objects in use.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: int
+
+Units: number of objects
+
+Default: 0 (Disables statement pooling.)
+
+Range: 0 through 2147483647
+```
+
+The value 0 disables statement pooling. Any negative value is treated
+like 0 (zero).
+
+TIP: To improve performance, we recommend that you enable statement pooling for
+your JDBC applications because this pooling can dramatically help the
+performance of many applications.
+
+NOTE: Statement pooling can be in effect only if connection pooling is
+enabled.
+
+*Example*
+
+To specify statement pooling, type:
+
+```
+maxStatements=10
+```
+
+<<<
+[[minpoolsize]]
+== minPoolSize Property
+
+The `minPoolSize` property limits the number of physical connections that
+can be in the free connection pool.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: int
+
+Default: -1 (The minPoolSize value is ignored.)
+
+Range: -1, 0 through n, but less than maxPoolSize
+```
+
+* Any negative value is treated like -1.
+
+* Any value greater than `maxPoolSize` is changed to the `maxPoolSize` value.
+
+* The value of `minPoolSize` is set to -1 when `maxPoolSize` is -1. The value determines
+connection pool use as follows:
+
+** When the number of physical connections in the free pool reaches the
+`minPoolSize` value, the Type 4 driver closes subsequent connections by
+physically closing them and not adding them to the free pool.
+
+** 0 (zero) means that the connections are not physically closed; the
+connections are always added to the free pool when the connection is
+closed.
+
+*Example*
+
+Use the following specification to set the `minPoolSize`
+value to 1, which ensures that one connection is always retained:
+
+```
+minPoolSize=1
+```
+
+<<<
+[[networktimeout]]
+== networkTimeout Property
+
+The `networkTimeout` property sets a time limit that the driver waits for
+a reply from the database server. When an operation is attempted for a
+period longer than the set value, in seconds, the driver stops waiting
+for a reply and returns an SQLException to the user application.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+CAUTION: Be careful when using this property. A network timeout causes
+the socket connection between the Type 4 driver and the connectivity
+server to timeout. If the server is engaged in a transaction or an SQL
+operation, then the server continues to perform that transaction or
+operation until the transaction or operation fails, the transaction
+manager times out, or the server realizes that the Type 4 driver client
+has gone away. A network timeout can result in an open transaction or
+operation that continues for a significant time before failing or
+rolling back. As a result of a network timeout, the connection becomes
+unavailable.
+
+```
+Data type: int
+
+Units: seconds
+
+Default: 0 (No network timeout is specified.)
+
+0 through to 2147483647
+```
+
+<<<
+[[password]]
+== password Property
+
+The `password` property sets the password value for passing to the DCS
+server. By using this property, you can also change the password. The
+password is encrypted when it is passed to the server.
+
+The format for specifying the password is:
+
+```
+password=old [, new, new ]
+```
+
+* `old` is the current password
+
+* `new` is the new password. Passwords must be 6 to 8 characters long and
+cannot contain double quotes (").
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: empty string
+```
+
+*Example*
+
+```
+password=eye0weU$
+```
+
+[[properties]]
+== properties Property
+
+The `properties` property specifies the location of the properties file
+that contains keyword-value pairs that specify property values for
+configuring the Type 4 driver. For more information, see
+<<creating-and-using-a-properties-file, Creating and Using a Properties File>>.
+
+<<<
+[[reservedatalocators]]
+== reserveDataLocators Property
+
+The `reserveDataLocators` property sets the number of data locators to be
+reserved for a process that stores data in a LOB table.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: int
+
+Units: number of data locators to be reserved
+
+Default: 100
+
+Range: 1 to 9,223,372,036,854,775,807 (2**63 -1)
+```
+
+Do not set a value much greater than the number of data locators
+actually needed. If the specified value is 0 (zero) or less, the default
+value (100) is used.
+
+Base the setting of the value of the `reserveDataLocators` property on the
+application profile being executed. If the application inserts a large
+number of LOB items, then a higher value of the `reserveDataLocators` property
+can prevent frequent updating of the `ZZ_DATA_LOCATOR` value in the LOB
+table. However, if the application inserts only a small number of LOB
+items, then a smaller value is better. If a large value is used, then holes
+(unused data-locator numbers) could occur in the LOB table. These holes
+represent unused space.
+
+Also, the administrator should avoid setting high values for the
+`reserveDataLocators` (for example, in the range of trillions or so).
+Setting high values prevents other Type 4 applications that use LOB
+table from reserving data locators.
+
+For additional information about data locator use, see
+<<reserving-data-locators, Reserving Data Locators>>.
+
+To change this value for a JDBC application, specify this property from
+the command line.
+
+*Example*
+
+The following command reserves 150 data
+locators for program class `myProgramClass`.
+
+```
+java -Dhpt4jdbc.reserveDataLocators=150 myProgramClass
+```
+
+<<<
+[[roundingmode]]
+== roundingMode Property
+
+The `roundingMode` property specifies the rounding behavior of the Type 4
+driver. For example, if the data is 1234.127 and column definition is
+`NUMERIC(6, 2)` and the application does `setDouble()` and `getDouble()`,
+then the value returned is 1234.12, which is truncated as specified by the
+default rounding mode, `ROUND_DOWN`.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: ROUND_DOWN
+```
+
+Values for roundingMode are:
+
+```
+ROUND_CEILING
+
+ROUND_DOWN
+
+ROUND_FLOOR
+
+ROUND_HALF_DOWN
+
+ROUND_HALF_EVEN
+
+ROUND_HALF_UP
+
+ROUND_UNNECESSARY
+
+ROUND_UP
+```
+
+* For the definition of rounding mode values, see the
+https://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html[java.math.BigDecimal] documentation.
+
+* If the application sets erroneous values for the `roundingMode` property, no error is thrown by the Type 4 driver.
+The driver uses `ROUND_DOWN` value instead.
+
+* To have the application get the `DataTruncation` exception when data is
+truncated, set the `roundingMode` property to `ROUND_UNNECESSARY`.
+
+<<<
+[[schema]]
+== schema Property
+
+The `schema` property sets the database schema that accesses SQL objects
+referenced in SQL statements if the SQL objects are not fully qualified.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: none
+```
+
+*Example*
+
+```
+schema=sales
+```
+
+<<<
+[[t4logfile]]
+== T4LogFile Property
+
+The `T4LogFile` property sets the name of the logging file for the Type 4 driver.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+```
+
+Default file name is defined by the following pattern:
+
+```
+%h/hpt4jdbc%u.log
+```
+
+where
+
+* `/` represents the local pathname separator.
+
+* `%h` represents the value of the user.home system property. _%u_
+represents a unique number to resolve conflicts.
+
+Any valid file name for your system is allowed.
+
+If you explicitly specify a log file, then that file is overwritten each time
+a `FileHandler` is established using that file name.
+
+To retain previously created log files, use the standard
+`java.util.logging `file syntax to append a unique number onto each log
+file.
+
+*Example*
+
+You can have the following property in a data source:
+
+```
+T4LogFile = C:/temp/MyLogFile%u.log
+```
+
+That name causes the Type 4 driver to create a new log file using a
+unique name for each connection made through that data source.
+
+<<<
+*Example*
+
+```
+C:/temp/MyLogFile43289.log
+
+C:/temp/MyLogFile87634.log
+
+C:/temp/MyLogFile27794.log
+```
+
+If you explicitly specify a log file that is not fully qualified, the
+Type 4 driver creates the file in the current working directory, for
+example, in the directory from which the JVM was invoked.
+
+For detailed information about java.util.logging, see the
+https://docs.oracle.com/javase/7/docs/api/java/util/logging/package-summary.html[logging summary] documentation.
+
+<<<
+[[t4loglevel]]
+== T4LogLevel Property
+
+The `T4LogLevel` property sets the logging levels that control logging
+output for the Type 4 driver. The Java package java.util.logging logs
+error messages and traces messages in the driver.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: OFF
+```
+
+*Logging Levels*
+[cols="20%,80%",options="header" ]
+|===
+| Level | Description
+| `OFF` | A special level that turns off logging; the default setting.
+| `SEVERE` | Indicates a serious failure; usually applies to SQL exceptions generated by the Type 4 driver.
+| `WARNING` | Indicates a potential problem, which usually applies to SQL warnings generated by the Type 4 driver.
+| `INFO` | Provides informational messages, typically about connection pooling, statement pooling, and resource usage. This information can
+help in tuning application performance.
+| `CONFIG` | Provides static configuration messages that can include property values and other Type 4 driver configuration information.
+| `FINE` | Provides tracing information from the Type 4 driver methods described in the Type 4 driver API. The level of tracing is equivalent
+to the level of tracing provided when calling the `setLogWriter()` method of the `DriverManager` class or the DataSource class.
+| `FINER` | Indicates a detailed tracing message for which internal Type 4 driver methods provide messages. These messages can be useful in debugging the Type 4 driver.
+| `FINEST` | Indicates a highly detailed tracing message. The driver provides detailed internal data messages that can be useful in debugging the Type 4 driver.
+| `ALL` |Logs all messages.
+|===
+
+*Example*
+
+To enable tracing, use the `hpt4jdbc.T4LogLevel` property specified in the command line:
+
+```
+-Dhpt4jdbc.T4LogLevel=FINE
+```
+
+<<<
+[[t4loglevel-considerations]]
+=== T4LogLevel Considerations
+
+* If a security manager is defined by your application using an AppServer,
+then `LoggingPermission` must be must be granted in the `java.policy` file as
+follows:
++
+```
+permission java.util.logging.LoggingPermission "control", "" ;
+```
+
+* The Type 4 driver is not designed to inherit the `java.util.logging.FileHandler.level` settings at program startup.
+
+<<<
+[[translationverification]]
+== translationVerification Property
+
+The `translationVerification` property defines the behavior of the driver
+if the driver cannot translate all or part of an SQL statement or SQL
+parameter.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+The value can be TRUE or FALSE.
+
+```
+Data type: String
+
+Default: FALSE
+```
+
+
+[cols="10%,45%,45%", options="header"]
+|===
+| Value | Scenario | What Happens
+| `FALSE` | The driver is unable to translate all or part of an SQL statement, then the translation is unspecified. |
+In most cases, the characters that are untranslatable are encoded as ISO88591 single-byte question marks (`?` or `0x3F`). No
+exception or warning is thrown.
+| `TRUE` | The driver cannot translation all or part of an SQL statement or parameter. | The driver throws an SQLException with this text. +
+ +
+`Translation of parameter to {0} failed. Cause: {1}` +
+ +
+where `{0}` is replaced with the target character set and `{1}` is
+replaced with the cause of the translation failure.
+|===
+
+NOTE: If the `translationVerification` property is set to TRUE, then the process can
+use significantly more system resources. For better performance, set this property to FALSE.
+
+For more information, see <<internationalization-support, Internationalization Support>>.
+
+<<<
+[[url]]
+== url Property
+
+The `url` property sets the URL value for the database.
+This property is used in the `DriverManager` object. The format
+to specify the URL is:
+
+```
+jdbc:hpt4jdbc//<primary IP addr or hostname of database>:37800/[:]
+[ property=value [ ; property2=value ] ... ]
+```
+
+where `<primary IP_addr or hostname of database>:37800>` specifies the location of the database.
+
+```
+Data type: String
+
+Default: none
+```
+
+*Example*
+
+```
+url=jdbc:hpt4jdbc://mynode.mycompanynetwork.net:37800/
+```
+
+[[url-property-considerations]]
+=== url Property Considerations
+
+* If the url parameter is not specified and `DriverManager.getConnection()` is called, then the Type 4 driver throws an SQLException.
+
+* If you use a literal IPV4 or IPV6 address in a URL, note these guidelines:
+
+** *For IPV6 only*: enclose the address in brackets (`[` and `]`).
+
+** The port number is optional according to both the IPV4 and IPV6 standard.
+
+** The default port number for the database is `37800`.
+
+<<<
+[[user]]
+== user Property
+
+The `user` property sets the role value for the connectivity service. The
+role name passed must have adequate access permissions for SQL data
+accessed through the connectivity service.
+
+Set this property on a `DataSource` object, `ConnectionPoolDataSource`
+object, or `DriverManager` object.
+For information about how to set properties, see
+<<how-to-specify-jdbc-type-4-properties, How to Specify JDBC Type 4 Properties>>.
+
+```
+Data type: String
+
+Default: empty string
+
+```
+
+*Example*
+
+```
+user=System_rolename
+```
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc
new file mode 100644
index 0000000..b44f0c9
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc
@@ -0,0 +1,245 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[type-4-driver-properties]]
+= Type 4 Driver Properties
+
+[[summary-of-type-4-driver-properties]]
+== Summary of Type 4 Driver Properties
+
+Type 4 driver properties that effect client-side operations are
+summarized in the following tables. For the detailed description, click
+the link provided in the property name.
+
+NOTE: Unless otherwise noted in the brief description, the particular
+property applies to the `DataSource` object, `DriverManager` object, and
+`ConnectionPoolDataSource` object.
+
+[[client-side-properties]]
+=== Client-Side Properties
+
+*Connection-Control Properties*
+[cols="25%,55%,30%",options="header" ]
+|===
+| Property Name | Description | Default Value
+| `<<dataSourceName, dataSourceName>>` | Specifies the registered DataSource or ConnectionPoolDataSource name. (Can be set only on the DriverManager object.) | None.
+| `<<loginTimeout, loginTimeout>>` | Sets the time limit that a connection can be attempted before the connection disconnects. | 60 (seconds)
+| `<<networkTimeout, networkTimeout>>` | Sets a time limit that the driver waits for a reply from the database server. | 0 (No network timeout is specified.
+|===
+
+*Pooling Management Properties*
+[cols="25%,55%,30%",options="header" ]
+|===
+| Property Name | Description | Default Value
+| `<<initialPoolSize, initialPoolSize>>` | Sets the initial connection pool size when connection pooling is used with the Type 4 driver. (Ignored for
+connections made through the ConnectionPoolDataSource object.) | -1 (Do not create an initial connection pool.)
+| `<<maxIdleTime, maxIdleTime>>` | Sets the number of seconds that a physical connection can remain unused in the pool before the connection is closed. | 0 (Specifies no limit.)
+| `<<maxPoolSize, maxPoolSize>>` | Sets the maximum number of physical connections that the pool can contain. | -1 (Disables connection pooling.)
+| `<<maxStatements, maxStatements>>` | Sets the total number of PreparedStatement objects that the connection pool should cache. | 0 (Disables statement pooling.)
+| `<<minPoolSize, minPoolSize>>` | Limits the number of physical connections that can be in the free connection pool. | -1 (The minPoolSize value is ignored.)
+|===
+
+////
+*Operations on CLOB and BLOB Data*
+[cols="25%,55%,30%",options="header" ]
+|===
+| Property Name | Description | Default Value
+| `<<blobTableName, blobTableName>>` | Specifies the LOB table for using BLOB columns. | None.
+| `<<clobTableName, clobTableName>>` | Specifies the LOB table for using CLOB columns. | None.
+| `<<reserveDataLocators,reserveDataLocators>>` | Sets the number of data locators to be reserved for a process that stores data in a LOB table. | 100
+|===
+////
+
+<<<
+*Internationalization Properties*
+[cols="25%,55%,30%",options="header" ]
+|===
+| Property Name | Description | Default Value
+| `<<ISO88591, ISO88591>>` | Sets character-set mapping that corresponds to the ISO88591 character set. | ISO88591_1
+| `<<KANJI, KANJI>>` | Sets character-set mapping that corresponds to the KANJI character set. | SJIS (which is shift-JIS, Japanese)
+| `<<KSC5601, KSC5601>>` | Sets character-set mapping that corresponds to the KSC5601 character set. | ECU_KR (which is KS C 5601, ECU encoding, Korean)
+| `<<language, language>>` | Sets the language used for error messages. | None.
+| `<<translationVerification, translationVerification>>` | Defines the behavior of the driver if the driver cannot translate all or part of an SQL statement or SQL parameter. | FALSE
+|===
+
+*Logging and Tracing Properties*
+[cols="25%,55%,30%",options="header" ]
+|===
+| Property Name | Description | Default Value
+| `<<T4LogFile, T4LogFile>>` | Sets the name of the logging file for the Type 4 driver. | The name is defined by the following pattern: `%h/hpt4jdbc%u.log`
+| `<<T4LogLevel, T4LogLevel>>` | Sets the logging levels that control logging output for the Type 4 driver. | OFF
+|===
+
+*Miscellaneous Client-Side Properties*
+[cols="25%,55%,30%",options="header" ]
+|===
+| Property Name | Description | Default Value
+| `<<description, description>>` | Specifies the registered source name. | None.
+| `<<fetchBufferSize, fetchBufferSize>>` | Provides the benefits of bulk fetch when rows are fetched from a `ResultSet` object. | 4 kilobytes
+| `<<properties, properties>>` | Specifies the location of the properties file that contains keyword-value pairs
+that specify property values for configuring the Type 4 driver. | None.
+| `<<roundingMode, roundingMode>>` | Specifies the rounding behavior of the Type 4 driver. | ROUND_DOWN
+|===
+
+<<<
+[[server-side-properties]]
+=== Server-Side Properties
+
+The Type 4 driver properties that effect server-side operations are
+summarized in the following tables. Unless otherwise noted in the
+description, the particular property applies to the DataSource object,
+`DriverManager` object, and `ConnectionPoolDataSource` object.
+
+*Type 4 Driver Server-Side Properties*
+[cols="25%,55%,30%",options="header" ]
+|===
+| Property Name | Description | Default Value
+| `<<catalog, catalog>>` | Sets the default catalog used to access SQL objects referenced in SQL
+statements if the SQL objects are not fully qualified. | None. Must be "Seabase" in the current release.
+| `<<connectionTimeout, connectionTimeout>>` | Sets the number of seconds a connection can be idle before the connection is physically closed by DCS. |
+-1 (Use the ConnTimeout value set on the server data source.)
+| `<<password, password>>` | Sets the password value for passing to the database. Can also change the password. | Empty string.
+| `<<schema, schema>>` | Sets the database schema that accesses SQL objects referenced in SQL statements if the SQL objects are not fully qualified. | None.
+| `<<url, url>>` | Sets the URL value for the database. Can be set only on the `DriverManager` object. | None.
+| `<<user, user>>` | Sets the user value for the database. | None.
+|===
+
+[[how-to-specify-jdbc-type-4-properties]]
+== How to Specify JDBC Type 4 Properties
+
+The Type 4 JDBC driver properties configure the driver. These properties
+can be specified in a data source, a connection URL (the primary IP
+address or host name on the database), a properties file,
+or in the java command line.
+
+Java properties have the form:
+
+```
+key=value
+```
+
+At run time, the driver looks for a specific set of property keys and
+takes action based on their associated values.
+
+<<<
+[[where-to-set-properties]]
+=== Where to Set Properties
+
+* For connections made through a `DataSource` or a `ConnectionPoolDataSource`,
+set the property on the `DataSource` or the `ConnectionPoolDataSource` object.
+
+* For the `DriverManager` class, set properties in either of two ways:
++
+1. Using the option `-Dproperty_name=property_value` in the command line.
+2. Using the `java.util.Properties` parameter in the `getConnection()` method
+of the `DriverManager` class.
+
+[[creating-and-using-a-properties-file]]
+=== Creating and Using a Properties File
+
+JDBC applications can provide property values to configure a connection
+by using a file that contains properties for the JDBC driver. This
+property file is passed as a java command-line parameter. The format to
+enter the properties file in the command line is:
+
+```
+-Dhpt4jdbc.properties=<path of the properties file on disk>`
+```
+
+*Example*
+
+```
+-Dhpt4jdbc.properties=C:\temp\t4props\myprops.properties
+```
+
+To create the file, use the editor of your choice on your workstation to
+type in the property values. The entries in properties file must have a
+`property_name=property_value` value-pair format:
+
+```
+property_name=property_value
+```
+
+*Example*
+
+```
+maxStatements=1024
+```
+
+To configure a `DataSource` connection, the properties file might contain
+property names and values as indicated in the following list:
+
+```
+url=jdbc:hpt4jdbc://<primary IP addr or host name of database>:37800/
+user=database_username
+password=mypassword
+description=<a string>
+catalog=Seabase
+schema=myschema
+maxPoolSize=20
+minPoolSize=5
+maxStatements=20
+loginTimeout=15
+initialPoolSize=10
+connectionTimeout=10
+serverDataSource=server_data_source
+T4LogLevel=OFF
+T4LogFile=/mylogdirectory/mylogfile
+```
+
+[[setting-properties-in-the-command-line]]
+=== Setting Properties in the Command Line
+
+When a Type 4 driver property is specified on the command line through
+the java `-D` option, the property must include the prefix: `hpt4jdbc`.
+
+This notation, which includes the period (.), ensures that all the Type
+4 driver property names are unique for a Java application.
+
+*Example*
+
+The maxStatements property becomes:
+
+```
+-Dhpt4jdbc.maxStatements=10
+```
+
+[[precedence-of-property-specifications]]
+=== Precedence of Property Specifications
+
+If a particular property is set several ways by an application, the
+value used depends on how the value was set according to the following
+order of precedence:
+
+1. Set on the `DataSource` object, `DriverManager` object, or
+`ConnectionPoolDataSource` object.
+
+2. Set through the `java.util.Properties` parameter in the `getConnection`
+method of `DriverManager` class.
+
+3. Set the property in a properties file specified by the
+`hpt4jdbc.properties` property.
+
+4. Set the `-Dhpt4jdbc.property_name=<property value>` in the java command line.
+
+For more information, see order of precedence for properties specified
+in various ways for use with the Driver Manager.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
new file mode 100644
index 0000000..daedec0
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
@@ -0,0 +1,195 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[tracing-and-logging-facilities]]
+= Tracing and Logging Facilities
+
+The Type 4 driver provides two tracing and logging facilities:
+
+* Standard JDBC tracing and logging functionality as defined by the JDBC standard
+* Type 4 driver logging facility
+
+Server-side tracing (logging) is enabled by configuring DCS.
+
+[[standard-jdbc-tracing-and-logging-facility]]
+== Standard JDBC Tracing and Logging Facility
+
+The JDBC standard provides a logging and tracing facility, which allows
+tracing JDBC method calls by setting the log writer. To set the log
+writer, either call the `setLogWriter()` method on the `DriverManager` class
+or call the `setLogWriter()` method on the `DataSource` class
+(or `ConnectionPoolDataSource` class).
+
+* A `DriverManager` log writer is a character output stream to which all
+logging and tracing messages for all connections made through the
+`DriverManager` are printed. This stream includes messages printed by the
+methods of this connection, messages printed by methods of other objects
+manufactured by the connection, and so on. The `DriverManager` log writer
+is initially null, that is, the default is for logging to be disabled.
+
+For information about using the setLogWriter method, see the
+https://docs.oracle.com/javase/7/docs/api/java/sql/DriverManager.html[DriverManager class API].
+
+* A `DataSource` log writer is a character output stream to which all
+logging and tracing messages for this data source are printed. This
+stream includes messages printed by the methods of this object, messages
+printed by methods of other objects manufactured by this object, and so
+on. Messages printed to a data-source-specific log writer are not
+printed to the log writer associated with the `java.sql.DriverManager`
+class. When a `DataSource` object is created, the log writer is initially
+null; that is, the default is for logging to be disabled.
+
+For information about using the setLogWriter method, see the
+https://docs.oracle.com/cd/E16338_01/appdev.112/e13995/oracle/jdbc/pool/OracleDataSource.html[DriverSource interface API].
+
+<<<
+[[the-type-4-driver-logging-facility]]
+== The Type 4 Driver Logging Facility
+
+
+The Type 4 driver Logging facility allows you to retrieve internal
+tracing information, which you can use in debugging the driver. It also
+allows you to capture error and warning messages.
+
+In addition to the standard JDBC tracing and logging facility, the Type
+4 driver provides an independent logging facility (Type 4 Driver
+Logging). The Type 4 Driver Logging provides the same level of logging
+and tracing as the standard JDBC tracing and logging facility with the
+following additional information:
+
+* More detail about the internals of the Type 4 driver and internal tracing information
+* Type 4 driver performance-tuning information
+* Finer control over the amount and type of logging information
+* Error and warning messages
+
+[[accessing-the-type-4-driver-logging-facility]]
+=== Accessing the Type 4 Driver Logging Facility
+
+The Type 4 Driver Logging facility is based on the `java.util.logging`
+package. The Type 4 driver instantiates a `java.util.logging.Logger` class
+and names the logger `org.trafodion.t4jdbc.logger`.
+
+Your JDBC program can access the Type 4 driver logger directly by
+calling the `java.util.logging.Logger` static method `getLogger(String)`.
+
+*example*
+
+[source, java]
+----
+String t4Logger =
+ java.util.logging.Logger.getLogger( "org.trafodion.t4jdbc.logger" ) ;
+----
+
+<<<
+[[controlling-type-4-driver-logging-output]]
+=== Controlling Type 4 Driver Logging Output
+
+The Type 4 driver provides two properties that you can use to control logging output.
+
+* `T4LogLevel`: Specifies the level of logging. For information about using this property, see <<t4loglevel-property, T4LogLevel Property>>.
+* `T4LogFile`: Specifies the file to which the driver is to write logging information. For information about using this property,
+see <<t4logfile-property, T4LogFile Property>>.
+
+If the application sets several property values, see
+<<precedence-of-property-specifications, Precedence of Property Specifications>> to determine which setting applies.
+
+*Example*
+
+These properties file entries set the logging level to SEVERE and specify a log file name:
+
+```
+T4LogLevel= SEVERE
+
+T4LogFile=c:/T4logfile1.log
+```
+<<<
+[[message-format]]
+=== Message Format
+
+The format of the trace output is
+
+```
+sequence-number ~ time-stamp ~ thread-id
+~ [connection-id] ~ [server-id] ~ [dialogue-id]
+~ [class].[method][(parameters)] ~ [text]
+```
+
+
+[cols="30%,70%",options="header" ]
+|===
+| Identifier | Provides
+| `sequence-number` | A unique sequence number in increasing order.
+| `time-stamp` | The time of the message, for example 10/17/2004 12:48:23.
+| `thread-id` | The thread identifier within the Java VM.
+| `connection-id` | If applicable, a unique ID for the connection associated with the message.
+| `server-id` | If applicable, information about the connectivity server associated with the message. The _server-id_ is of the form: +
+ +
+`TCP:node-name.server-name/port-number:HPODBC` +
+ +
+where +
+ +
+`node-name` is the name of the {project-name} database node. +
+`server-name` is the name of the {project-name} platform. +
+`port-number` is the port to which the server is connected. +
+ +
+*Example* +
+ +
+`TCP:\banshee-tcp.$Z0133/46003:HPODBC`
+| `dialogue-id` | If applicable, the `dialogue-id` used for the DCS connection.
+| `class` | If applicable, the name of the class that issued the logging request.
+| `method` | If applicable, the name of the method that issued the logging request.
+| `parameters` | An optional set of parameters associated with the method.
+| `text` | Optional textual information for the message.
+|===
+
+NOTE: The tilde (`~`) character separates message parts. This separator
+allows you to format the message using tools, such as Excel, Word, UNIX
+sort, and so forth. For example, you can format and sort messages based
+on sequence number or thread ID. You can edit the log file and change
+the separator (the tilde) to any character you want. When possible,
+numbers (such as `thread-id` and `sequence-number`) are prepended with
+zeros (0) to allow for readable formatting.
+
+<<<
+[[examples-of-logging-output]]
+=== Examples of Logging Output
+
+* Output where `T4LogLevel` is set to `SEVERE`:
++
+```
+00000036 ~ Dec 8, 2006 10:05:55 AM PST ~ 10 ~ 4508606 ~ null
+ ~ null ~ HPT4Messages.createSQLException("en_US",
+ "socket_write_error", "null") ~
+```
+
+* Output where `T4LogLevel` is set to `FINER`:
++
+```
+0000006 ~ 10/22/2004 10:34:45 ~ 001234 ~ 0049934 ~ FetchRowSetMessage ~ marshal
+ ~ Entering FetchRowSetMessage.marshal( en_US
+ , 48345
+ , STMT_MX_8843
+ , 5
+ , 4192,
+ , 0
+ , 0 )
+```
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/index.adoc b/docs/jdbct4ref_guide/src/asciidoc/index.adoc
new file mode 100644
index 0000000..38e2f3e
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/index.adoc
@@ -0,0 +1,74 @@
+////
+* @@@ 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 @@@
+////
+
+= JDBC Type 4 Programmer's Reference Guide
+:doctype: book
+:numbered:
+:toc: left
+:toclevels: 3
+:toc-title: Table of Contents
+:icons: font
+:iconsdir: icons
+:experimental:
+:source-language: text
+:revnumber: {project-version}
+:title-logo-image: {project-logo}
+:project-name: {project-name}
+
+:images: ../images
+:sourcedir: ../../resources/source
+
+:leveloffset: 1
+
+// The directory is called _chapters because asciidoctor skips direct
+// processing of files found in directories starting with an _. This
+// prevents each chapter being built as its own book.
+
+include::../../shared/license.txt[]
+<<<
+include::resources/acknowledgements.txt[]
+
+<<<
+*Revision History*
+
+[cols="2",options="header"]
+|===
+| Version | Date
+| 2.0.0 | To be announced.
+| 1.3.0 | January, 2016
+|===
+
+include::asciidoc/_chapters/about.adoc[]
+include::asciidoc/_chapters/introduction.adoc[]
+include::asciidoc/_chapters/accessing.adoc[]
+include::asciidoc/_chapters/properties_overview.adoc[]
+include::asciidoc/_chapters/properties_detail.adoc[]
+// include::asciidoc/_chapters/lob_data.adoc[]
+// include::asciidoc/_chapters/lob_management.adoc[]
+include::asciidoc/_chapters/compliance.adoc[]
+include::asciidoc/_chapters/tracing_logging.adoc[]
+include::asciidoc/_chapters/messages.adoc[]
+// include::asciidoc/_chapters/code_examples.adoc[]
+include::asciidoc/_chapters/avoiding_mismatch.adoc[]
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/images/lob_tables.jpg
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/images/lob_tables.jpg b/docs/jdbct4ref_guide/src/images/lob_tables.jpg
new file mode 100644
index 0000000..dd85bf1
Binary files /dev/null and b/docs/jdbct4ref_guide/src/images/lob_tables.jpg differ
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/resources/acknowledgements.txt
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/resources/acknowledgements.txt b/docs/jdbct4ref_guide/src/resources/acknowledgements.txt
new file mode 100644
index 0000000..c395596
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/resources/acknowledgements.txt
@@ -0,0 +1,38 @@
+*Acknowledgements*
+
+Microsoft�, Windows�, Windows NT�, Windows� XP, and Windows Vista� are
+U.S. registered trademarks of Microsoft Corporation. Intel� and Intel�
+Itanium� are trademarks of Intel Corporation in the U.S. and other
+countries. Java� is a registered trademark of Oracle and/or its
+affiliates. Motif, OSF/1, UNIX�, X/Open�, and the X device is a
+trademark of X/Open Company Ltd. in the UK and other countries.
+
+OSF, OSF/1, OSF/Motif, Motif, and Open Software Foundation are trademarks of
+the Open Software Foundation in the U.S. and other countries.
+� 1990, 1991, 1992, 1993 Open Software Foundation, Inc.
+
+The OSF documentation and the OSF software to which it relates are derived in
+part from materials supplied by the following: � 1987, 1988, 1989
+Carnegie-Mellon University. � 1989, 1990, 1991 Digital Equipment
+Corporation. � 1985, 1988, 1989, 1990 Encore Computer Corporation. � 1988 Free
+Software Foundation, Inc. � 1987, 1988, 1989, 1990, 1991 Hewlett-Packard
+Company. � 1985, 1987, 1988, 1989, 1990, 1991, 1992 International
+Business Machines Corporation. � 1988, 1989 Massachusetts Institute of
+Technology. � 1988, 1989, 1990 Mentat Inc. � 1988 Microsoft Corporation.
+� 1987, 1988, 1989, 1990, 1991,
+1992 SecureWare, Inc. � 1990, 1991 Siemens Nixdorf Informations systeme
+AG. � 1986, 1989, 1996, 1997 Sun Microsystems, Inc. � 1989, 1990, 1991
+Transarc Corporation.
+
+OSF software and documentation are based in part
+on the Fourth Berkeley Software Distribution under license from The
+Regents of the University of California. OSF acknowledges the following
+individuals and institutions for their role in its development: Kenneth
+C.R.C. Arnold, Gregory S. Couch, Conrad C. Huang, Ed James, Symmetric
+Computer Systems, Robert Elz. � 1980, 1981, 1982, 1983, 1985, 1986,
+1987, 1988, 1989 Regents of the University of California. OSF MAKES NO
+WARRANTY OF ANY KIND WITH REGARD TO THE OSF MATERIAL PROVIDED HEREIN,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE. OSF shall not be liable for errors
+contained herein or for incidental consequential damages in connection
+with the furnishing, performance, or use of this material.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/resources/source/blob_example.java
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/resources/source/blob_example.java b/docs/jdbct4ref_guide/src/resources/source/blob_example.java
new file mode 100644
index 0000000..d4415af
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/resources/source/blob_example.java
@@ -0,0 +1,202 @@
+// @@@ 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 @@@
+//
+
+// LOB operations may be performed through the Blob, or
+// PreparedStatement interface. This program shows examples of
+// using both interfaces taking a byte[] variable and putting
+// it into the cat.sch.blobtiff table.
+//
+// The LOB base table for this example is created as:
+// >> CREATE TABLE blobtiff
+// ( col1 INT NOT NULL NOT DROPPABLE
+// , tiff BLOB
+// , PRIMARY KEY ( col1 )
+// ) ;
+//
+// The LOB table for this example is created through the
+// T4LobAdmin utility as:
+// >> CREATE TABLE seabase.sch.blobdatatbl
+// ( table_name CHAR(128) NOT NULL NOT DROPPABLE
+// , data_locator LARGEINT NOT NULL NOT DROPPABLE
+// , chunk_no INT NOT NULL NOT DROPPABLE
+// , lob_data VARCHAR(3880)
+// , PRIMARY KEY ( table_name, data_locator, chunk_no )
+// ) ;
+//
+// ***** The following is the blob interface...
+// - insert the base row with EMPTY_BLOB() as value for
+// the LOB column
+// - select the lob column 'for update'
+// - load up a byte[] with the data
+// - use Outputstream.write(byte[])
+//
+// ***** The following is the prep stmt interface...
+// - need an Inputstream object that already has data
+// - need a PreparedStatement object that contains the
+// 'insert...' DML of the base table
+// - ps.setAsciiStream() for the lob data
+// - ps.executeupdate(); for the DML
+//
+// To run this example, issue the following:
+// # java TestBLOB 1 TestBLOB.class 1000
+//
+import java.sql.* ;
+import java.io.* ;
+
+public class TestBLOB
+{
+ public static void main (String[] args) throws java.io.FileNotFoundException, java.io.IOException
+ {
+ int numBytes ;
+ int recKey ;
+ long start ;
+ long end ;
+ Connection conn1 = null ;
+
+ // Set hpt4jdbc.blobTableName System Property. This property
+ // can also be added to the command line through
+ // "-Dhpt4jdbc.blobTableName=...", or a
+ // java.util.Properties object can be used and passed to
+ // getConnection.
+ System.setProperty( "hpt4jdbc.blobTableName", "Seabase.sch.blobdatatbl" );
+
+ if ( args.length < 2 )
+ {
+ System.out.println( "arg[0]=; arg[1]=file; arg[2]=") ;
+ return ;
+ }
+
+ // byte array for the blob
+ byte[] whatever = new byte[5000] ;
+ for ( int i=0; i<5000; i++ ) whatever[i] = 71 ; // "G"
+
+ String k = "K";
+ for ( int i=0; i<5000; i++) k = k + "K" ;
+ System.out.println( "string length = " + k.length() ) ;
+
+ java.io.ByteArrayInputStream iXstream =
+ new java.io.ByteArrayInputStream( whatever ) ;
+
+ numBytes = iXstream.available( );
+ if ( args.length == 3 )
+ numBytes = Integer.parseInt( args[2] ) ;
+ recKey = Integer.parseInt( args[0] ) ;
+ System.out.println( "Key: "
+ + recKey
+ + "; Using "
+ + numBytes
+ + " of file "
+ + args[1]
+ ) ;
+
+ try
+ {
+ Class.forName( "org.trafodion.t4jdbc.HPT4Driver" ) ;
+ start = System.currentTimeMillis() ;
+
+ // url should be of the form:
+ // jdbc:hpt4jdbc://ip_address|host_name:37800/:"
+ // where host_name is the database host name
+ String url = "jdbc:hpt4jdbc://host_name:37800/:" ;
+ conn1 = DriverManager.getConnection( url ) ;
+
+ System.out.println( "Cleaning up test tables..." ) ;
+ Statement stmt0 = conn1.createStatement() ;
+ stmt0.execute( "DELETE FROM blobdatatbl" ) ;
+ stmt0.execute( "DELETE FROM blobtiff" ) ;
+ conn1.setAutoCommit(false) ;
+ }
+ catch (Exception e1)
+ {
+ e1.printStackTrace();
+ }
+
+ // PreparedStatement interface example - This technique is
+ // suitable if the LOB data is already on disk
+ try
+ {
+ System.out.println( "PreparedStatement interface LOB insert..." ) ;
+
+ String stmtSource1 = "INSERT INTO blobtiff VALUES ( ?, ? ) " ;
+ PreparedStatement stmt1 = conn1.prepareStatement( stmtSource1 ) ;
+ stmt1.setInt( 1, recKey ) ;
+ stmt1.setBinaryStream( 2, iXstream, numBytes ) ;
+ stmt1.executeUpdate() ;
+ conn1.commit() ;
+ }
+ catch ( SQLException e )
+ {
+ e.printStackTrace() ;
+ SQLException next = e ;
+
+ do
+ {
+ System.out.println( "Messge : " + e.getMessage() ) ;
+ System.out.println( "Error Code : " + e.getErrorCode() ) ;
+ System.out.println( "SQLState : " + e.getSQLState() ) ;
+ }
+ while ( ( next = next.getNextException() ) != null ) ;
+ }
+
+ // Blob interface example - This technique is suitable when
+ // the LOB data is already in the app, such as having been
+ // transfered in a msgbuf.
+ try
+ {
+ // insert a second base table row with empty LOB column
+ System.out.println( "BLOB interface LOB insert..." ) ;
+ String stmtSource2 = "INSERT INTO blobtiff VALUES ( ?, EMPTY_BLOB() ) " ;
+ PreparedStatement stmt2 = conn1.prepareStatement( stmtSource2 ) ;
+ stmt2.setInt( 1, recKey+1 ) ;
+ stmt2.executeUpdate() ;
+ Blob tiff = null ;
+
+ System.out.println( "Obtaining BLOB data to update (EMPTY in this case)..." ) ;
+ PreparedStatement stmt3 =
+ conn1.prepareStatement( "SELECT tiff FROM blobtiff WHERE col1 = ? FOR UPDATE" ) ;
+ stmt3.setInt( 1, recKey+1 ) ;
+ ResultSet rs = stmt3.executeQuery() ;
+
+ if ( rs.next() )
+ // has to be there else the base table insert failed
+ tiff = rs.getBlob( 1 ) ;
+
+ System.out.println( "Writing data to previously empty BLOB..." ) ;
+ OutputStream os = tiff.setBinaryStream( 1 ) ;
+
+ byte[] bData = k.getBytes() ;
+ os.write( bData ) ;
+ os.close() ;
+ conn1.commit() ;
+ }
+ catch ( SQLException e )
+ {
+ e.printStackTrace() ;
+ SQLException next = e ;
+
+ do
+ {
+ System.out.println( "Messge : " + e.getMessage() ) ;
+ System.out.println( "Vendor Code : " + e.getErrorCode() ) ;
+ System.out.println( "SQLState : " + e.getSQLState() ) ;
+ }
+ while ( ( next = next.getNextException()) != null ) ;
+ }
+ } // main
+} // class
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/resources/source/clob_example.java
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/resources/source/clob_example.java b/docs/jdbct4ref_guide/src/resources/source/clob_example.java
new file mode 100644
index 0000000..bcceb33
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/resources/source/clob_example.java
@@ -0,0 +1,200 @@
+// @@@ 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 @@@
+//
+
+// LOB operations can be performed through the Clob interface,
+// or the PreparedStatement interface.
+// This program shows examples of both interfaces taking a
+// variable and putting it into the cat.sch.clobbase table.
+//
+// The LOB base table for this example is created as:
+// >> CREATE TABLE clobbase
+// ( col1 INT NOT NULL NOT DROPPABLE
+// , col2 CLOB
+// , PRIMARY KEY ( col1 )
+// ) ;
+//
+// The LOB table for this example is created through
+// the T4LobAdmin utility as:
+// >> CREATE TABLE seabase.sch.clobdatatbl
+// ( table_name CHAR(128) NOT NULL NOT DROPPABLE
+// , data_locator LARGEINT NOT NULL NOT DROPPABLE
+// , chunk_no INT NOT NULL NOT DROPPABLE
+// , lob_data VARCHAR(3880)
+// , PRIMARY KEY ( table_name, data_locator, chunk_no )
+// ) ;
+//
+// ***** The following is the Clob interface...
+// - insert the base row with EMPTY_CLOB() as value for
+// the LOB column
+// - select the LOB column 'for update'
+// - load up a byte[] with the data
+// - use Outputstream.write(byte[])
+//
+// ***** The following is the PreparedStatement interface...
+// - need an Inputstream object that already has data
+// - need a PreparedStatement object that contains the
+// 'insert...' DML of the base table
+// - ps.setAsciiStream() for the lob data
+// - ps.executeupdate(); for the DML
+//
+// To run this example, issue the following:
+// # java TestCLOB 1 TestCLOB.java 1000
+//
+import java.sql.* ;
+import java.io.* ;
+
+public class TestCLOB
+{ public static void main ( String[] args )
+ throws java.io.FileNotFoundException, java.io.IOException
+ {
+ int length = 500 ;
+ int recKey ;
+ long start ;
+ long end ;
+ Connection conn1 = null ;
+
+ // Set hpt4jdbc.clobTableName System Property. This property
+ // can also be added to the command line through
+ // "-Dhpt4jdbc.clobTableName=...", or a
+ // java.util.Properties object can be used and passed to
+ // getConnection.
+ System.setProperty( "hpt4jdbc.clobTableName"
+ , "Seabase.sch.clobdatatbl"
+ ) ;
+
+ if ( args.length < 2 )
+ {
+ System.out.println( "arg[0]=; arg[1]=file; arg[2]=") ;
+ return;
+ }
+
+ String k = "K" ;
+ for ( int i=0 ; i<5000 ; i++ ) k = k + "K" ;
+ System.out.println( "string length = " + k.length() ) ;
+
+ FileInputStream clobFs = new FileInputStream( args[1] ) ;
+ int clobFsLen = clobFs.available() ;
+
+ if ( args.length == 3 )
+ length = Integer.parseInt( args[2] ) ;
+ recKey = Integer.parseInt( args[0] ) ;
+ System.out.println( "Key: "
+ + recKey
+ + "; Using "
+ + length
+ + " of file "
+ + args[ 1 ]
+ ) ;
+
+ try
+ {
+ Class.forName( "org.trafodion.t4jdbc.HPT4Driver" ) ;
+ start = System.currentTimeMillis() ;
+
+ // url should be of the form:
+ // jdbc:hpt4jdbc://ip_address|host_name:37800/:"
+ // where host_name is the database host name
+ String url= "jdbc:hpt4jdbc://host_name:37800/:" ;
+ conn1 = DriverManager.getConnection( url ) ;
+
+ System.out.println( "Cleaning up test tables..." ) ;
+ Statement stmt0 = conn1.createStatement() ;
+ stmt0.execute( "DELETE FROM clobdatatbl" ) ;
+ stmt0.execute( "DELETE FROM clobbase" ) ;
+ conn1.setAutoCommit( false ) ;
+ }
+ catch (Exception e1)
+ {
+ e1.printStackTrace() ;
+ }
+
+ // PreparedStatement interface example - This technique
+ // is suitable if the LOB data is already on disk.
+ try
+ {
+ System.out.println("PreparedStatement interface LOB insert...") ;
+ String stmtSource1 = "INSERT INTO clobbase VALUES (?,?) " ;
+
+ PreparedStatement stmt1 = conn1.prepareStatement( stmtSource1 ) ;
+ stmt1.setInt( 1, recKey ) ;
+ stmt1.setAsciiStream( 2, clobFs, length ) ;
+ stmt1.executeUpdate() ;
+ conn1.commit() ;
+ }
+ catch (SQLException e)
+ {
+ e.printStackTrace() ;
+ SQLException next = e ;
+ do
+ {
+ System.out.println( "Message : " + e.getMessage() ) ;
+ System.out.println( "Error Code : " + e.getErrorCode() ) ;
+ System.out.println( "SQLState : " + e.getSQLState() ) ;
+ }
+ while ( ( next = next.getNextException() ) != null ) ;
+ }
+
+ // Clob interface example - This technique is suitable when
+ // the LOB data is already in the app, such as having been
+ // transferred in a msgbuf.
+ try
+ {
+ // insert a second base table row with an empty LOB column
+ System.out.println( "CLOB interface EMPTY LOB insert..." ) ;
+ String stmtSource2 = "INSERT INTO clobbase VALUES ( ?, EMPTY_CLOB() ) " ;
+
+ PreparedStatement stmt2 = conn1.prepareStatement( stmtSource2 ) ;
+ stmt2.setInt( 1, recKey+1 ) ;
+ stmt2.executeUpdate() ;
+
+ Clob clob = null ;
+ System.out.println( "Obtaining CLOB data to update (EMPTY in this case)..." ) ;
+
+ PreparedStatement stmt3 =
+ conn1.prepareStatement( "SELECT col2 FROM clobbase WHERE col1 = ? FOR UPDATE" ) ;
+ stmt3.setInt( 1, recKey+1 ) ;
+ ResultSet rs = stmt3.executeQuery() ;
+
+ if ( rs.next() )
+ // has to be there else the base table insert fails
+ clob = rs.getClob( 1 ) ;
+
+ System.out.println( "Writing data to previously empty CLOB..." ) ;
+ OutputStream os = clob.setAsciiStream( 1 ) ;
+ byte[] bData = k.getBytes() ;
+ os.write(bData) ;
+ os.close() ;
+ conn1.commit() ;
+ }
+ catch (SQLException e)
+ {
+ e.printStackTrace() ;
+ SQLException next = e ;
+
+ do
+ {
+ System.out.println( "Message : " + e.getMessage() ) ;
+ System.out.println( "Vendor Code : " + e.getErrorCode() ) ;
+ System.out.println( "SQLState : " + e.getSQLState() ) ;
+ }
+ while ( ( next = next.getNextException() ) != null ) ;
+ }
+ } // main
+} // class
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc b/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc
index fa9dcda..a22f1a1 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc
@@ -32,10 +32,12 @@ sample database, see <<b-sample-database, Sample Database>> below.
* <<procedures-in-the-persnl-schema, Procedures in the PERSNL Schema>>
* <<procedures-in-the-invent-schema, Procedures in the INVENT Schema>>
-You can download each source sample by clicking the link provided with the
+NOTE: You can download each source sample by clicking the link provided with the
sample name. For example, click on
-link:/resources/source/Sales.java[Sales.java]
+link:{sourcedir}/Sales.java[Sales.java]
to download the sample sales class source file.
++
+You can access the complete source directory at: http://trafodion.apache.org/docs/spj_guide/resources/source/
<<<
[[procedures-in-the-sales-schema]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/spj_guide/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/index.adoc b/docs/spj_guide/src/asciidoc/index.adoc
index 19304c5..6bc14f9 100644
--- a/docs/spj_guide/src/asciidoc/index.adoc
+++ b/docs/spj_guide/src/asciidoc/index.adoc
@@ -32,8 +32,7 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-// :title-logo-image: {project-logo}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
:images: ../images
:sourcedir: ../../resources/source
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/spj_guide/src/resources/source/create_demo.sql
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/resources/source/create_demo.sql b/docs/spj_guide/src/resources/source/create_demo.sql
new file mode 100644
index 0000000..618d01c
--- /dev/null
+++ b/docs/spj_guide/src/resources/source/create_demo.sql
@@ -0,0 +1,14 @@
+obey persnl_schema.sql ;
+obey persnl_employee_table.sql ;
+obey persnl_job_table.sql ;
+obey persnl_dept_table.sql ;
+obey persnl_project_table.sql ;
+obey sales_schema.sql ;
+obey sales_customer_table.sql ;
+obey sales_orders_table.sql ;
+obey sales_odetail_table.sql ;
+obey sales_parts_table.sql ;
+obey invent_schema.sql ;
+obey invent_supplier_table.sql ;
+obey invent_partloc_table.sql ;
+obey invent_partsupp_table.sql ;
[06/22] incubator-trafodion git commit: Incorporated initial review
comments.
Posted by db...@apache.org.
Incorporated initial review comments.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/c5543bd8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/c5543bd8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/c5543bd8
Branch: refs/heads/master
Commit: c5543bd82d2ba7edca79b988423a1e4c1effafb6
Parents: 09be4be
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Sat Apr 30 12:52:23 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Sat Apr 30 12:52:23 2016 -0600
----------------------------------------------------------------------
docs/jdbct4ref_guide/pom.xml | 4 +-
.../src/asciidoc/_chapters/accessing.adoc | 60 +++++++++-----------
.../asciidoc/_chapters/avoiding_mismatch.adoc | 9 ---
.../src/asciidoc/_chapters/compliance.adoc | 27 ++-------
.../src/asciidoc/_chapters/introduction.adoc | 2 +-
.../src/asciidoc/_chapters/lob_management.adoc | 8 +--
.../asciidoc/_chapters/properties_detail.adoc | 20 +++----
.../src/asciidoc/_chapters/tracing_logging.adoc | 4 +-
8 files changed, 51 insertions(+), 83 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c5543bd8/docs/jdbct4ref_guide/pom.xml
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/pom.xml b/docs/jdbct4ref_guide/pom.xml
index 413710e..ef69349 100644
--- a/docs/jdbct4ref_guide/pom.xml
+++ b/docs/jdbct4ref_guide/pom.xml
@@ -242,8 +242,8 @@
- 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/jdbct4ref_guide/JDBCT4_Reference_Guide.pdf" />
- <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/${project.version}/jdbct4ref_guide/JDBCT4_Reference_Guide.pdf" />
+ <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/jdbct4ref_guide/Trafodion_JDBCT4_Reference_Guide.pdf" />
+ <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/${project.version}/jdbct4ref_guide/Trafodion_JDBCT4_Reference_Guide.pdf" />
<!-- Copy the Web Book files to their target directories -->
<copy todir="${basedir}/../target/docs/jdbct4ref_guide">
<fileset dir="${basedir}/target/site">
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c5543bd8/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc
index 7a6a647..a9b0e01 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc
@@ -38,8 +38,8 @@ methods for obtaining a JDBC connection to the underlying database.
All JDBC data source classes implement either the `javax.sql.DataSource`
interface or the `javax.sql.ConnectionPoolDataSource` interface. The Type
-4 driver data source classes are `org.trafodion.t4jdbc.HPT4DataSource` and
-`org.trafodion.t4jdbc.HPT4ConnectionPoolDataSource`. (These classes are
+4 driver data source classes are `org.trafodion.jdbc.t4.HPT4DataSource` and
+`org.trafodion.jdbc.t4.HPT4ConnectionPoolDataSource`. (These classes are
defined by the JDBC 3.0 specification.)
Typically, a user or system administrator uses a tool to create a data
@@ -50,22 +50,19 @@ connection to the underlying database.
A DataSource object maps to an instance of a database. In the Type 4
driver product, the DataSource object acts as an interface between the
-application code and the database and enables connection with an DCS
-data source.
+application code and the database and enables connection with a DCS
+(Data Connectivity Services) data source.
[[security]]
== Security
Clients connect to the {project-name} platform with a valid user name
-and ID, using standard JDBC 3.0 APIs. An application can make multiple
+and password, using standard JDBC 3.0 APIs. An application can make multiple
connections using different user IDs, and creating different Connection
objects.
The Type 4 driver provides for user name and password authentication.
-The password is encrypted with a proprietary algorithm provided by DCS.
-
-NOTE: There is no secure wire communication such as SSL provided for the
-communication between Type 4 driver and the {project-name} platform.
+The password is encrypted.
<<<
[[connection-by-using-the-datasource-interface]]
@@ -143,7 +140,7 @@ the `HPT4ConnectionPoolDataSource` object.
[source, java]
----
HPT4DataSource temp = new HPT4DataSource() ;
-temp.setCatalog( "Seabase" ) ;
+temp.setCatalog( "TRAFODION" ) ;
----
In the following example, the code fragment illustrates the methods that a
@@ -156,8 +153,8 @@ to use the Type 4 driver to access a {project-name} database:
----
HPT4DataSource ds = new HPT4DataSource() ;
-ds.setUrl( "jdbc:hpt4jdbc://<primary IP addr or host name>:18650/" );
-ds.setCatalog( "Seabase" ) ;
+ds.setUrl( "jdbc:t4jdbc://<primary IP addr or host name>:2300/" );
+ds.setCatalog( "TRAFODION" ) ;
ds.setSchema( "myschema" ) ;
ds.setUser( "gunnar" ) ;
ds.setPassword( "my_userpassword" ) ;
@@ -282,7 +279,7 @@ When an application issues a request for a connection using the
finds a suitable driver that recognizes this URL and obtains a database
connection using that driver.
-`org.trafodion.t4jdbc.HPT4Driver` is the Type 4 driver class that
+`org.trafodion.jdbc.t4.T4Driver` is the Type 4 driver class that
implements the `java.sql.Driver` interface.
<<<
@@ -297,21 +294,21 @@ one of the following ways:
command line of the Java program:
+
```
--Djdbc.drivers=org.trafodion.t4jdbc.HPT4Driver
+-Djdbc.drivers=org.trafodion.jdbc.t4.T4Driver
```
* Uses the `Class.forName` method programmatically within the application:
+
[source, java]
----
-Class.forName("org.trafodion.t4jdbc.HPT4Driver")
+Class.forName("org.trafodion.jdbc.t4.T4Driver")
----
* Adds the Type 4 driver class to the `java.lang.System` property
`jdbc.drivers` property within the application:
+
```
-jdbc.drivers=org.trafodion.t4jdbc.HPT4Driver
+jdbc.drivers=org.trafodion.jdbc.t4.T4Driver
```
<<<
@@ -322,14 +319,14 @@ The `DriverManager.getConnection` method accepts a string containing a
Type 4 driver URL. The JDBC URL for the Type 4 driver is
```
-jdbc:hpt4jdbc://<ip addr or host name>:3700/[:][property=value[;property2=value2]...]
+jdbc:t4jdbc://<ip addr or host name>:23400/[:][property=value[;property2=value2]...]
```
[cols="40%,60%", options="header"]
|===
| Parameter | Usage
| `<ip addr or host name>` | The primary IP address or host name for the {project-name} database.
-| `37800` | The port number for the {project-name} SQL database.
+| `23400` | The port number for the {project-name} SQL database.
| `property = value` and `property2=value2` | Specifies a Type 4 driver property name-property value pair. The pairs must be separated by a
semicolon (`;`). For example, `T4LogLevel=ALL;T4LogFile=temp1.log`.
|===
@@ -340,9 +337,9 @@ To establish a connection, the JDBC application can use this code:
[source, java]
----
-Class.forName( "org.trafodion.t4jdbc.HPT4Driver" ) ; //loads the driver
+Class.forName( "org.trafodion.jdbc.t4.T4Driver" ) ; //loads the driver
-String url = "jdbc:hpt4jdbc://<database primary IP address>:37800/"
+String url = "jdbc:hpt4jdbc://<database primary IP address>:23400/"
Connection con = DriverManager.getConnection( url, "userID", "Passwd" ) ;
----
@@ -364,7 +361,7 @@ the order of precedence):
2. Using the database URL in the `DriverManager.getconnection` method, where the URL is:
+
```
-jdbc:hpt4jdbc://<ip addr or host name>:37800/:property=value
+jdbc:t4jdbc://<ip addr or host name>:23400/:property=value
```
+
`<ip addr or host name>` is the primary IP address or host name for the {project-name} database.
@@ -375,10 +372,10 @@ passed as a command-line parameter. The format to enter the properties
file in the command line is:
+
```
--Dhpt4jdbc.properties=<path of properties file on disk>
+-Dt4jdbc.properties=<path of properties file on disk>
```
+
-For example, `-Dhpt4jdbc.properties=C:\temp\t4props`
+For example, `-Dt4jdbc.properties=C:\temp\t4props`
+
For information about the properties file, see <<creating-and-using-a-properties-file, Creating and Using a Properties File>>.
4. Using JDBC properties with the `-D` option in the command line. If
@@ -387,10 +384,10 @@ used, this option applies to all JDBC connections using the
line is:
+
```
--Dhpt4jdbc.property_name=<property value>
+-Dt4jdbc.property_name=<property value>
```
+
-For example, `-Dhpt4jdbc.maxStatements=1024`
+For example, `-Dt4jdbc.maxStatements=1024`
<<<
[[connection-pooling]]
@@ -431,7 +428,6 @@ catalog
schema
username
password
-serverDataSource
```
+
Therefore, connections that have the same values for the combination of
@@ -610,7 +606,7 @@ defined for the {project-name} JDBC Type 4 driver with class:
[source, java]
----
-org.trafodion.t4jdbc.HPT4PreparedStatement: public String
+org.trafodion.jdbc.t4.T4PreparedStatement: public String
getStatementLabel() ;
----
@@ -846,7 +842,7 @@ The property file that has the messages must have a file name in the
form:
```
-HPT4Messages_xx.properties
+T4Messages_xx.properties
```
where `xx` is the locale name. The locale name is defined by the current
@@ -855,7 +851,7 @@ default locale or by the language property.
The Type 4 driver is shipped with an error messages and status messages
property file that contains the textual representation of errors and
status messages for the English locale. The file is named
-`HPT4Messages_en.properties`.
+`T4Messages_en.properties`.
[[localized-message-string-format]]
==== Localized-Message String Format
@@ -884,12 +880,12 @@ driver. Any translation must include these placeholders.
[[procedure-to-create-a-localized-message-file]]
==== Procedure to Create a Localized-Message File
-1. Extract the `HPT4Messages_en.properties file`, which is in the
-`hpt4jdbc.jar file`.
+1. Extract the `T4Messages_en.properties file`, which is in the
+`jdbcT4-*.jar file`.
+
*Example*
+
-From a UNIX prompt, use the jar Java tool: `jar -x HPT4Messages_en.properties < hpt4jdbc.jar`
+From a UNIX prompt, use the jar Java tool: `jar -x T4Messages_en.properties < jdbcT4-*.jar`
2. Copy the file.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c5543bd8/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc
index 8d40e10..67b5289 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc
@@ -95,12 +95,3 @@ the server event log on node <logfile_location> for details.
* <errortext> is the error text from the server.
* <logfile_location> is the location of the log file.
-Additional error text returned only by a Release 2.2 server, but displayed by any version driver:
-
-```
-Version Mismatch: Client Version is: Pre R2.2.0 Server Version is:
-R2.2.0 Server vproc is:
-
-T7969N25_10AUG07_N25_AS_0613 ERROR
-```
-
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c5543bd8/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc
index 25eedf1..3c18eaf 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc
@@ -207,7 +207,7 @@ For details, see <<localizing-error-messages-and-status-messages, Localizing Err
[[additional-databasemetadata-apis]]
=== Additional DatabaseMetaData APIs
-APIs added to the `HPT4DatabaseMetaData` class provide these capabilities:
+APIs added to the `T4DatabaseMetaData` class provide these capabilities:
* Get a description of a table's synonyms.
+
@@ -225,25 +225,6 @@ public java.sql.ResultSet getMaterializedViewInfo(String catalog, String schema,
----
////
-[[additional-connection-apis]]
-=== Additional Connection APIs
-
-APIs added to the `HPT4Connection` class provide these capabilities:
-
-* Sets the current service name for this Connection object.
-+
-[source, java]
-----
-public void setServiceName(String serviceName) throws SQLException
-----
-
-* Gets (retrieves) the current service name of this Connection object. Default return value: HP_DEFAULT_SERVICE.
-+
-[source, java]
-----
-public String getServiceName() throws SQLException
-----
-
[[conformance-of-databasemetadata-methods-handling-of-null-parameters]]
== Conformance of DatabaseMetaData Methods' Handling of Null Parameters
@@ -304,9 +285,9 @@ The following table shows the JDBC data types that are supported by Type
| `Types.BIGINT` | Yes | `LARGEINT`
| `Types.BINARY` | Data type is mapped by {project-name} SQL. Data type varies from that used for table creation. | `CHAR(n)`^1^
| `Types.BIT` | Data type is mapped by {project-name} SQL. Data type varies from that used for table creation. | `CHAR(1)`
-| `Types.BLOB` | Yes | `LARGEINT`
+// | `Types.BLOB` | Yes | `LARGEINT`
| `Types.CHAR` | Yes | `CHAR(n)`
-| `Types.CLOB` | Yes | `LARGEINT`
+// | `Types.CLOB` | Yes | `LARGEINT`
| `Types.DATE` | Yes | `DATE`
| `Types.DECIMAL` | Yes | `DECIMAL(p,s)`
| `Types.DISTINCT` | No | Not applicable.
@@ -383,4 +364,4 @@ These features are not required for JDBC 3.0 compliance, and they are not suppor
* The Type 4 driver supports only database features that are supported by {project-name} SQL and SPJ.
Therefore, the Type 4 driver is not fully compliant with JDBC 3.0 specifications.
-* The Type 4 driver depends on the HP connectivity service for all server side manageability related features.
+* The Type 4 driver depends on DCS (Data Connectivity Service) for all server side manageability related features.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c5543bd8/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc
index a0f8219..5547dab 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc
@@ -35,7 +35,7 @@ platforms that support JDK 1.4.1 or higher.
[[type-4-driver-api-package]]
== Type 4 Driver API Package
-The Type 4 driver package, `org.trafodion.t4jdbc`, is shipped with the
+The Type 4 driver package, `org.trafodion.jdbc.t4`, is shipped with the
driver software. For class and method descriptions, see the
_{project-name} JDBC Type 4 Driver API Reference_.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c5543bd8/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc
index 7fd5794..73715a2 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc
@@ -128,7 +128,7 @@ Run the T4LobAdmin utility from the workstation. The format of the
command is:
```
-java [java_options] org.trafodion.t4jdbc.T4LobAdmin [prog_options] [table_name]
+java [java_options] org.trafodion.jdbc.t4.T4LobAdmin [prog_options] [table_name]
```
[[java-options]]
@@ -183,14 +183,14 @@ For information about catalog, schema, and table names, see the
To display help for the Type 4 Lob Admin Utility, type:
```
-java org.trafodion.t4jdbc.T4LobAdmin -help
+java org.trafodion.jdbc.t4.T4LobAdmin -help
```
*Example*
```
Apache Trafodion T4 Lob Admin Utility 1.0 (c) Copyright 2015-2016
-org.trafodion.t4jdbc.T4LobAdmin [<prog_options>] [<table_name>]
+org.trafodion.jdbc.t4.T4LobAdmin [<prog_options>] [<table_name>]
<java_options> is:
[-Dhpt4jdbc.properties=<properties file>]
@@ -254,7 +254,7 @@ contains a BLOB column, and executes those statements.
```
java -Dhpt4jdbc.blobTableName=sales.paris.lobTable4pictures /
-org.trafodion.t4jdbc.T4LobAdmin -trigger -exec sales.paris.pictures
+org.trafodion.jdbc.t4.T4LobAdmin -trigger -exec sales.paris.pictures
```
[[limitations-of-lob-data-clob-and-blob-data-types]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c5543bd8/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc
index 632ea7e..876cc71 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_detail.adoc
@@ -53,10 +53,10 @@ Default: none
*Example*
-Specifying the catalog Seabase:
+Specifying the catalog TRAFODION:
```
-catalog=Seabase
+catalog=TRAFODION
```
////
@@ -235,7 +235,7 @@ Default: SJIS (which is shift-JIS, Japanese)
*Example*
```
-java -Dhpt4jdbc.KANJI=SJIS
+java -Dt4jdbc.KANJI=SJIS
```
For more information, see
@@ -267,7 +267,7 @@ http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html[Jav
*Example*
```
-java -Dhpt4jdbc.KSC5601=ECU_KR
+java -Dt4jdbc.KSC5601=ECU_KR
```
For more information, see
@@ -744,7 +744,7 @@ Data type: String
Default file name is defined by the following pattern:
```
-%h/hpt4jdbc%u.log
+%h/t4jdbc%u.log
```
where
@@ -833,7 +833,7 @@ to the level of tracing provided when calling the `setLogWriter()` method of the
To enable tracing, use the `hpt4jdbc.T4LogLevel` property specified in the command line:
```
--Dhpt4jdbc.T4LogLevel=FINE
+-Dt4jdbc.T4LogLevel=FINE
```
<<<
@@ -900,11 +900,11 @@ This property is used in the `DriverManager` object. The format
to specify the URL is:
```
-jdbc:hpt4jdbc//<primary IP addr or hostname of database>:37800/[:]
+jdbc:t4jdbc//<primary IP addr or hostname of database>:23400/[:]
[ property=value [ ; property2=value ] ... ]
```
-where `<primary IP_addr or hostname of database>:37800>` specifies the location of the database.
+where `<primary IP_addr or hostname of database>:23400>` specifies the location of the database.
```
Data type: String
@@ -915,7 +915,7 @@ Default: none
*Example*
```
-url=jdbc:hpt4jdbc://mynode.mycompanynetwork.net:37800/
+url=jdbc:t4jdbc://mynode.mycompanynetwork.net:23400/
```
[[url-property-considerations]]
@@ -929,7 +929,7 @@ url=jdbc:hpt4jdbc://mynode.mycompanynetwork.net:37800/
** The port number is optional according to both the IPV4 and IPV6 standard.
-** The default port number for the database is `37800`.
+** The default port number for the database is `23400`.
<<<
[[user]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c5543bd8/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
index daedec0..0d7cb9b 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
@@ -86,7 +86,7 @@ following additional information:
The Type 4 Driver Logging facility is based on the `java.util.logging`
package. The Type 4 driver instantiates a `java.util.logging.Logger` class
-and names the logger `org.trafodion.t4jdbc.logger`.
+and names the logger `org.trafodion.jdbc.t4.logger`.
Your JDBC program can access the Type 4 driver logger directly by
calling the `java.util.logging.Logger` static method `getLogger(String)`.
@@ -96,7 +96,7 @@ calling the `java.util.logging.Logger` static method `getLogger(String)`.
[source, java]
----
String t4Logger =
- java.util.logging.Logger.getLogger( "org.trafodion.t4jdbc.logger" ) ;
+ java.util.logging.Logger.getLogger( "org.trafodion.jdbc.t4.logger" ) ;
----
<<<
[10/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/sql_functions_and_expressions.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/sql_functions_and_expressions.adoc b/docs/sql_reference/src/asciidoc/_chapters/sql_functions_and_expressions.adoc
index d797172..1053033 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/sql_functions_and_expressions.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/sql_functions_and_expressions.adoc
@@ -20,14 +20,14 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[sql_functions_and_expressions]]
= SQL Functions and Expressions
This section describes the syntax and semantics of specific functions
-and expressions that you can use in Trafodion SQL statements. The
+and expressions that you can use in {project-name} SQL statements. The
functions and expressions are categorized according to their
functionality.
@@ -354,7 +354,7 @@ See the individual entry for the function.
== ABS Function
The ABS function returns the absolute value of a numeric value
-expression. ABS is a Trafodion SQL extension.
+expression. ABS is a {project-name} SQL extension.
```
ABS (numeric-expression)
@@ -384,7 +384,7 @@ ABS (-20 + 12)
The ACOS function returns the arccosine of a numeric value expression as
an angle expressed in radians.
-ACOS is a Trafodion SQL extension.
+ACOS is a {project-name} SQL extension.
```
ACOS (numeric-expression)
@@ -418,7 +418,7 @@ ACOS (COS (0.3491))
=== ADD_MONTHS Function
The ADD_MONTHS function adds the integer number of months specified by
-_int_expr_ to _datetime_expr_ and normalizes the result. ADD_MONTHS is a Trafodion SQL
+_int_expr_ to _datetime_expr_ and normalizes the result. ADD_MONTHS is a {project-name} SQL
extension.
```
@@ -484,7 +484,7 @@ The ASCII function returns the integer that is the ASCII code of the
first character in a character string expression associated with either
the ISO8891 character set or the UTF8 character set.
-ASCII is a Trafodion SQL extension.
+ASCII is a {project-name} SQL extension.
```
ASCII (character-expression)
@@ -499,7 +499,7 @@ characters. See <<character_value_expressions,Character Value Expressions>>.
=== Considerations For ASCII
For a string expression in the UTF8 character set, if the value of the
-first byte in the string is greater than 127, Trafodion SQL returns this
+first byte in the string is greater than 127, {project-name} SQL returns this
error message:
```
@@ -533,7 +533,7 @@ SALESREP 83
The ASIN function returns the arcsine of a numeric value expression as
an angle expressed in radians.
-ASIN is a Trafodion SQL extension.
+ASIN is a {project-name} SQL extension.
```
ASIN (numeric-expression)
@@ -549,7 +549,7 @@ from -1 to +1. See <<numeric_value_expressions,Numeric Value Expressions>>.
=== Considerations for ASCII
For a string expression in the UTF8 character set, if the value of the
-first byte in the string is greater than 127, Trafodion SQL returns this
+first byte in the string is greater than 127, {project-name} SQL returns this
error message:
```
@@ -583,7 +583,7 @@ SALESREP 83
The ASIN function returns the arcsine of a numeric value expression as
an angle expressed in radians.
-ASIN is a Trafodion SQL extension.
+ASIN is a {project-name} SQL extension.
```
ASIN (numeric-expression)
@@ -619,7 +619,7 @@ ASIN(SIN(0.3491))
The ATAN function returns the arctangent of a numeric value expression
as an angle expressed in radians.
-ATAN is a Trafodion SQL extension.
+ATAN is a {project-name} SQL extension.
```
ATAN ( numeric-expression )
@@ -655,7 +655,7 @@ The ATAN2 function returns the arctangent of the x and y coordinates,
specified by two numeric value expressions, as an angle expressed in
radians.
-ATAN2 is a Trafodion SQL extension.
+ATAN2 is a {project-name} SQL extension.
```
ATAN2 (numeric-expression-x,numeric-expression-y)
@@ -912,15 +912,15 @@ The following are BITAND restrictions:
The CASE expression is a conditional expression with two forms: simple
and searched.
-In a simple CASE expression, Trafodion SQL compares a value to a
+In a simple CASE expression, {project-name} SQL compares a value to a
sequence of values and sets the CASE expression to the value associated
-with the first match — if a match exists. If no match exists, Trafodion
+with the first match — if a match exists. If no match exists, {project-name}
SQL returns the value specified in the ELSE clause (which can be null).
-In a searched CASE expression, Trafodion SQL evaluates a sequence of
+In a searched CASE expression, {project-name} SQL evaluates a sequence of
conditions and sets the CASE expression to the value associated with the
first condition that is true — if a true condition exists. If no true
-condition exists, Trafodion SQL returns the value specified in the ELSE
+condition exists, {project-name} SQL returns the value specified in the ELSE
clause (which can be null).
*Simple CASE is*:
@@ -1161,8 +1161,8 @@ converting to DATE, the contents of the character string must be 10
characters consisting of the year, a hyphen, the month, another hyphen,
and the day.
-* A date value to a character string or to a TIMESTAMP (Trafodion SQL fills in the time part with 00:00:00.00).
-* A time value to a character string or to a TIMESTAMP (Trafodion SQL fills in the date part with the current date).
+* A date value to a character string or to a TIMESTAMP ({project-name} SQL fills in the time part with 00:00:00.00).
+* A time value to a character string or to a TIMESTAMP ({project-name} SQL fills in the date part with the current date).
* A timestamp value to a character string, a DATE, a TIME, or another TIMESTAMP with different fractional seconds precision.
* A year-month interval value to a character string, an exact numeric,
or to another year-month INTERVAL with a different start field precision.
@@ -1201,7 +1201,7 @@ VALUES (001, 'User JBrook, executed at ' || CAST (CURRENT_TIMESTAMP AS CHAR(26))
The CEILING function returns the smallest integer, represented as a
FLOAT data type, greater than or equal to a numeric value expression.
-CEILING is a Trafodion SQL extension.
+CEILING is a {project-name} SQL extension.
```
CEILING (numeric-expression)
@@ -1230,7 +1230,7 @@ CEILING (2.25)
The CHAR function returns the character that has the specified code
value, which must be of exact numeric with scale 0.
-CHAR is a Trafodion SQL extension.
+CHAR is a {project-name} SQL extension.
```
CHAR(code-value, [,char-set-name])
@@ -1289,9 +1289,9 @@ CHAR[ACTER]_LENGTH (string-value-expression)
* `_string-value-expression_`
+
specifies the string value expression for which to return the length in
-characters. Trafodion SQL returns the result as a two-byte signed
+characters. {project-name} SQL returns the result as a two-byte signed
integer with a scale of zero. If _string-value-expression_ is null,
-Trafodion SQL returns a length of
+{project-name} SQL returns a length of
null. See <<character_value_expressions,Character Value Expressions>>.
[[considerations_for_char_length]]
@@ -1300,8 +1300,8 @@ null. See <<character_value_expressions,Character Value Expressions>>.
[[char_and_varchar_operands]]
==== CHAR and VARCHAR Operands
-For a column declared as fixed CHAR, Trafodion SQL returns the maximum
-length of that column. For a VARCHAR column, Trafodion SQL returns the
+For a column declared as fixed CHAR, {project-name} SQL returns the maximum
+length of that column. For a VARCHAR column, {project-name} SQL returns the
actual length of the string stored in that column.
[[examples_of_char_length]]
@@ -1387,7 +1387,7 @@ that is the code point of the first character in a character value
expression that can be associated with one of the supported character
sets.
-CODE_VALUE is a Trafodion SQL extension.
+CODE_VALUE is a {project-name} SQL extension.
```
CODE_VALUE(character-value-expression)
@@ -1420,7 +1420,7 @@ The CONCAT function returns the concatenation of two character value
expressions as a character string value. You can also use the
concatenation operator (\|\|).
-CONCAT is a Trafodion SQL extension.
+CONCAT is a {project-name} SQL extension.
```
CONCAT (character-expr-1, character-expr-2)
@@ -1480,7 +1480,7 @@ a string value of '5 March':
The type assignment of the parameter ?p becomes CHAR(5), the same data
type as the character literal ' 2002'. Because you assigned a string
-value of more than five characters to ?p, Trafodion SQL returns a
+value of more than five characters to ?p, {project-name} SQL returns a
truncation warning, and the result of the concatenation is 5 Mar 2002.
To specify the type assignment of the parameter, use the CAST expression
@@ -1516,7 +1516,7 @@ VALUES (002, 'Executed at ' || CAST (CURRENT_TIMESTAMP AS CHAR(26)));
The CONVERTTOHEX function converts the specified value expression to
hexadecimal for display purposes.
-CONVERTTOHEX is a Trafodion SQL extension.
+CONVERTTOHEX is a {project-name} SQL extension.
```
CONVERTTOHEX (expression)
@@ -1615,7 +1615,7 @@ SELECT CONVERTTOHEX(IV1), CONVERTTOHEX(IV2), CONVERTTOHEX(IV3) from IVT;
The CONVERTTIMESTAMP function converts a Julian timestamp to a value
with data type TIMESTAMP.
-CONVERTTIMESTAMP is a Trafodion SQL extension.
+CONVERTTIMESTAMP is a {project-name} SQL extension.
```
CONVERTTIMESTAMP (julian-timestamp)
@@ -1679,7 +1679,7 @@ is the same value, 2008-04-03 21:05:36.143000.
The COS function returns the cosine of a numeric value expression, where
the expression is an angle expressed in radians.
-COS is a Trafodion SQL extension.
+COS is a {project-name} SQL extension.
```
COS (numeric-expression)
@@ -1709,7 +1709,7 @@ COS (0.3491)
The COSH function returns the hyperbolic cosine of a numeric value
expression, where the expression is an angle expressed in radians.
-COSH is a Trafodion SQL extension.
+COSH is a {project-name} SQL extension.
```
COSH (numeric-expression)
@@ -2051,7 +2051,7 @@ in years or months, DATE_ADD normalizes the result. See
_datetime_expr_ is returned, unless the _interval_expression_ contains
any time components, then a timestamp is returned.
-DATE_ADD is a Trafodion SQL extension.
+DATE_ADD is a {project-name} SQL extension.
```
DATE_ADD (datetime-expr, interval-expression)
@@ -2066,7 +2066,7 @@ TIMESTAMP. See <<datetime_value_expressions,Datetime Value Expressions>>.
+
is an expression that can be combined in specific ways with addition
operators. The _interval_expression_ accepts all interval expression
-types that the Trafodion database software considers as valid interval
+types that the {project-name} database software considers as valid interval
expressions. See <<interval_value_expressions,Interval Value Expressions>>.
<<<
@@ -2110,7 +2110,7 @@ DATE_SUB normalizes the result. See <<standard_normalization,Standard Normalizat
The type of the _datetime_expr_ is returned, unless the _interval_expression_ contains
any time components, then a timestamp is returned.
-DATE_SUB is a Trafodion SQL extension.
+DATE_SUB is a {project-name} SQL extension.
```
DATE_SUB (datetime-expr, interval-expression)
@@ -2125,7 +2125,7 @@ TIMESTAMP. See <<datetime_value_expressions,Datetime_Value_Expression>>.
+
is an expression that can be combined in specific ways with subtraction
operators. The _interval_expression_ accepts all interval expression
-types that the Trafodion database software considers as valid interval
+types that the {project-name} database software considers as valid interval
expressions. see <<interval_value_expressions,Interval Value Expressions>>.
<<<
@@ -2168,7 +2168,7 @@ years or months, DATEADD normalizes the result. See
_datetime-expr_ is returned, unless the interval expression contains any
time components, then a timestamp is returned.
-DATEADD is a Trafodion SQL extension.
+DATEADD is a {project-name} SQL extension.
```
DATEADD(datepart, num-expr, datetime-expr)
@@ -2243,7 +2243,7 @@ The DATEDIFF function returns the integer value for the number of
_datepart_ units of time between _startdate_ and _enddate_. If
_enddate_ precedes _startdate_, the return value is negative or zero.
-DATEDIFF is a Trafodion SQL extension.
+DATEDIFF is a {project-name} SQL extension.
```
DATEDIFF (datepart, startdate, enddate)
@@ -2354,7 +2354,7 @@ The DATEFORMAT function returns a datetime value as a character string
literal in the DEFAULT, USA, or EUROPEAN format. The data type of the
result is CHAR.
-DATEFORMAT is a Trafodion SQL extension.
+DATEFORMAT is a {project-name} SQL extension.
```
DATEFORMAT (datetime-expression,{DEFAULT | USA | EUROPEAN})
@@ -2404,7 +2404,7 @@ as an exact numeric value. The DATE_PART function accepts the
specification of 'YEAR', 'MONTH', 'DAY', 'HOUR', 'MINUTE', or 'SECOND'
for text.
-DATE_PART is a Trafodion SQL extension.
+DATE_PART is a {project-name} SQL extension.
```
DATEPART (text, interval)
@@ -2417,7 +2417,7 @@ enclosed in single quotes.
* `_interval_`
+
-_interval_ accepts all interval expression types that the Trafodion
+_interval_ accepts all interval expression types that the {project-name}
database software considers as valid interval expressions. See
<<interval_value_expressions,Interval Value Expressions>>.
@@ -2463,7 +2463,7 @@ The DATE_PART function of a timestamp can be changed to DATE_PART
function of a datetime because the second argument can be either a
timestamp or a date expression.
-DATE_PART is a Trafodion extension.
+DATE_PART is a {project-name} extension.
```
DATEPART(text, datetime-expr)
@@ -2530,7 +2530,7 @@ The DATE_TRUNC function returns a value of type TIMESTAMP, which has all
fields of lesser precision than _text_ set to zero (or 1 in the case of
months or days).
-DATE_TRUNC is a Trafodion SQL extension.
+DATE_TRUNC is a {project-name} SQL extension.
```
DATE_TRUNC(text, datetime-expr)
@@ -2584,7 +2584,7 @@ value in the range 1 through 31 that represents the corresponding day of
the month. The result returned by the DAY function is equal to the
result returned by the DAYOFMONTH function.
-DAY is a Trafodion SQL extension.
+DAY is a {project-name} SQL extension.
```
DAY (datetime-expression)
@@ -2619,7 +2619,7 @@ The DAYNAME function converts a DATE or TIMESTAMP expression into a
character literal that is the name of the day of the week (Sunday,
Monday, and so on).
-DAYNAME is a Trafodion SQL extension.
+DAYNAME is a {project-name} SQL extension.
```
DAYNAME (datetime-expression)
@@ -2660,7 +2660,7 @@ INTEGER value in the range 1 through 31 that represents the
corresponding day of the month. The result returned by the DAYOFMONTH
function is equal to the result returned by the DAY function.
-DAYOFMONTH is a Trafodion SQL extension.
+DAYOFMONTH is a {project-name} SQL extension.
```
DAYOFMONTH (datetime-expression)
@@ -2696,7 +2696,7 @@ INTEGER value in the range 1 through 7 that represents the corresponding
day of the week. The value 1 represents Sunday, 2 represents Monday, and
so forth.
-DAYOFWEEK is a Trafodion SQL extension.
+DAYOFWEEK is a {project-name} SQL extension.
```
DAYOFWEEK (datetime-expression)
@@ -2733,7 +2733,7 @@ The DAYOFYEAR function converts a DATE or TIMESTAMP expression into an
INTEGER value in the range 1 through 366 that represents the
corresponding day of the year.
-DAYOFYEAR is a Trafodion SQL extension.
+DAYOFYEAR is a {project-name} SQL extension.
```
DAYOFYEAR (datetime-expression)
@@ -2770,7 +2770,7 @@ corresponding _retval_ is returned. If no match is found, _default_ is
returned. If no match is found and _default_ is omitted, NULL is
returned.
-DECODE is a Trafodion SQL extension.
+DECODE is a {project-name} SQL extension.
```
DECODE (expr, test-expr, retval [, test-expr2, retval2 ... ] [ , default ] )
@@ -2929,9 +2929,9 @@ SELECT DECODE( (?p1 || ?p2), trim(?p1), 'Hi', ?p3, null ) from emp;
*** ERROR[8822] The statement was not prepared.
```
+
-The last _ret-val_ is an explicit NULL. When Trafodion SQL encounters
+The last _ret-val_ is an explicit NULL. When {project-name} SQL encounters
this situation, it assumes that the return value will be NUMERIC(18,6).
-Once Trafodion SQL determines that the return values are numeric, it
+Once {project-name} SQL determines that the return values are numeric, it
determines that all possible return values must be numeric. When 'Hi' is
encountered in a _ret-val_ position, the error is produced because the
CHAR(2) type argument is not comparable with a NUMERIC(18,6) type return
@@ -2950,7 +2950,7 @@ SELECT DECODE( (?p1 || ?p2), trim(?p1), 'Hi' ) from emp;
The DEGREES function converts a numeric value expression expressed in
radians to the number of degrees.
-DEGREES is a Trafodion SQL extension.
+DEGREES is a {project-name} SQL extension.
```
DEGREES (numeric-expression)
@@ -2987,7 +2987,7 @@ change in an expression from row to row in an intermediate result table
ordered by a sequence by clause in a select statement.
See <<sequence_by_clause,SEQUENCE BY Clause>>.
-DIFF1 is a Trafodion SQL extension.
+DIFF1 is a {project-name} SQL extension.
```
DIFF1 (column-expression-a [,column-expression-b])
@@ -3034,9 +3034,9 @@ computation could result in a divisor of zero.
[[datetime-arguments]]
==== Datetime Arguments
-In general, Trafodion SQL does not allow division by a value of INTERVAL
+In general, {project-name} SQL does not allow division by a value of INTERVAL
data type. However, to permit use of the two-argument version of DIFF1
-with times and dates, Trafodion SQL relaxes this restriction and allows
+with times and dates, {project-name} SQL relaxes this restriction and allows
division by a value of INTERVAL data type.
[[examples_of_diff1]]
@@ -3120,7 +3120,7 @@ change in a DIFF1 value from row to row in an intermediate result table
ordered by a SEQUENCE BY clause in a SELECT statement. See
<<sequence_by_clause,SEQUENCE BY Clause>>.
-DIFF2 is a Trafodion SQL extension.
+DIFF2 is a {project-name} SQL extension.
```
DIFF2 (column-expression-a [,column-expression-b])
@@ -3169,9 +3169,9 @@ computation could result in a divisor of zero.
[[datetime_arguments]]
==== Datetime Arguments
-In general, Trafodion SQL does not allow division by a value of INTERVAL
+In general, {project-name} SQL does not allow division by a value of INTERVAL
data type. However, to permit use of the two-argument version of DIFF2
-with times and dates, Trafodion SQL relaxes this restriction and allows
+with times and dates, {project-name} SQL relaxes this restriction and allows
division by a value of INTERVAL data type.
[[examples_of_diff2]]
@@ -3226,7 +3226,7 @@ DIFF2_I1TS
== EXP Function
This function returns the exponential value (to the base e) of a numeric
-value expression. EXP is a Trafodion SQL extension.
+value expression. EXP is a {project-name} SQL extension.
```
EXP (numeric-expression)
@@ -3338,9 +3338,9 @@ rows are returned as the result of the SELECT statement.
[[obtaining_an_explain_plan_while_queries_are_running]]
==== Obtaining an EXPLAIN Plan While Queries Are Running
-Trafodion SQL provides the ability to capture an EXPLAIN plan for a
+{project-name} SQL provides the ability to capture an EXPLAIN plan for a
query at any time while the query is running with the QID option. By
-default, this behavior is disabled for a Trafodion session.
+default, this behavior is disabled for a {project-name} session.
NOTE: Enable this feature before you start preparing and executing
queries.
@@ -3387,7 +3387,7 @@ or events in the plan.
| Column Name | Data Type | Description
| MODULE_NAME | CHAR(60) | Reserved for future use.
| STATEMENT_ NAME | CHAR(60) | Statement name; truncated on the right if longer than 60 characters.
-| PLAN_ID | LARGEINT | Unique system-generated plan ID automatically assigned by Trafodion SQL;
+| PLAN_ID | LARGEINT | Unique system-generated plan ID automatically assigned by {project-name} SQL;
generated at compile time.
| SEQ_NUM | INT | Sequence number of the current operator in the operator tree; indicates
the sequence in which the operator tree is generated.
@@ -3504,7 +3504,7 @@ The HOUR function converts a TIME or TIMESTAMP expression into an
INTEGER value in the range 0 through 23 that represents the
corresponding hour of the day.
-HOUR is a Trafodion SQL extension.
+HOUR is a {project-name} SQL extension.
```
HOUR (datetime-expression)
@@ -3541,7 +3541,7 @@ a specified start position, and where another character string has been
inserted at the start position. Every character, including multi-byte
characters, is treated as one character.
-INSERT is a Trafodion SQL extension.
+INSERT is a {project-name} SQL extension.
```
INSERT (char-expr-1, start, length, char-expr-2)
@@ -3603,7 +3603,7 @@ The ISNULL function returns the value of the first argument if it is not
null, otherwise it returns the value of the second argument. Both
expressions must be of comparable types.
-ISNULL is a Trafodion SQL extension.
+ISNULL is a {project-name} SQL extension.
```
ISNULL(ck-expr, repl-value)
@@ -3651,7 +3651,7 @@ datetime value. JULIANTIMESTAMP returns a value of data type LARGEINT.
The function is evaluated once when the query starts execution and is
not reevaluated (even if it is a long running query).
-JULIANTIMESTAMP is a Trafodion SQL extension.
+JULIANTIMESTAMP is a {project-name} SQL extension.
```
JULIANTIMESTAMP(datetime-expression)
@@ -3661,7 +3661,7 @@ JULIANTIMESTAMP(datetime-expression)
+
is an expression that evaluates to a value of type DATE, TIME, or
TIMESTAMP. If _datetime-expression_ does not contain all the fields from YEAR through
-SECOND, Trafodion SQL extends the value before converting it to a Julian
+SECOND, {project-name} SQL extends the value before converting it to a Julian
timestamp. Datetime fields to the left of the specified datetime value
are set to current date fields. Datetime fields to the right of the
specified datetime value are set to zero. See
@@ -3715,7 +3715,7 @@ The LASTNOTNULL function is a sequence function that returns the last
non-null value of a column in an intermediate result table ordered by a
SEQUENCE BY clause in a SELECT statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-LASTNOTNULL is a Trafodion SQL extension.
+LASTNOTNULL is a {project-name} SQL extension.
```
LASTNOTNULL(column-expression)
@@ -3762,7 +3762,7 @@ the result returned by the <<lower_function,LOWER Function>>.
LCASE returns a string of fixed-length or variable-length character
data, depending on the data type of the input string.
-LCASE is a Trafodion SQL extension.
+LCASE is a {project-name} SQL extension.
```
LCASE (character-expression)
@@ -3802,7 +3802,7 @@ The LEFT function returns the leftmost specified number of characters
from a character expression. Every character, including multi-byte
characters, is treated as one character.
-LEFT is a Trafodion SQL extension.
+LEFT is a {project-name} SQL extension.
```
LEFT (character-expr, count)
@@ -3858,13 +3858,13 @@ SECRETARY COMNET
== LOCATE Function
The LOCATE function searches for a given substring in a character
-string. If the substring is found, Trafodion SQL returns the character
+string. If the substring is found, {project-name} SQL returns the character
position of the substring within the string. Every character, including
multi-byte characters, is treated as one character. The result returned
by the LOCATE function is equal to the result returned by the
<<position_function,Position Function>>.
-LOCATE is a Trafodion SQL extension.
+LOCATE is a {project-name} SQL extension.
```
LOCATE(substring-expression,source-expression)
@@ -3882,8 +3882,8 @@ is an SQL character value expression that specifies the source string.
the _source-expression_ cannot be null.
See <<character_value_expressions,Character Value Expressions>>.
-Trafodion SQL returns the result as a 2-byte signed integer with a scale
-of zero. If substring-expression is not found in source-expression , Trafodion
+{project-name} SQL returns the result as a 2-byte signed integer with a scale
+of zero. If substring-expression is not found in source-expression , {project-name}
SQL returns 0.
[[considerations_for_locate]]
@@ -3893,11 +3893,11 @@ SQL returns 0.
==== Result of LOCATE
* If the length of _source-expression_ is zero and the length of
-_substring-expression_ is greater than zero, Trafodion SQL returns 0.
-* If the length of _substring-expression_ is zero, Trafodion SQL returns 1.
+_substring-expression_ is greater than zero, {project-name} SQL returns 0.
+* If the length of _substring-expression_ is zero, {project-name} SQL returns 1.
* If the length of _substring-expression_ is greater than the length of
-_source-expression_, Trafodion SQL returns 0.
-* If _source-expression_ is a null value, Trafodion SQL returns a null value.
+_source-expression_, {project-name} SQL returns 0.
+* If _source-expression_ is a null value, {project-name} SQL returns a null value.
[[using_ucase]]
==== Using UCASE
@@ -3929,7 +3929,7 @@ WHERE LOCATE ('SMITH',UCASE(empname)) > 0 ;
== LOG Function
The LOG function returns the natural logarithm of a numeric value
-expression. LOG is a Trafodion SQL extension.
+expression. LOG is a {project-name} SQL extension.
```
LOG (numeric-expression)
@@ -3958,7 +3958,7 @@ LOG (2.0)
The LOG10 function returns the base 10 logarithm of a numeric value
expression.
-LOG10 is a Trafodion SQL extension.
+LOG10 is a {project-name} SQL extension.
```
LOG10 (numeric-expression)
@@ -4050,7 +4050,7 @@ The LPAD function pads the left side of a string with the specified
string. Every character in the string, including multi-byte characters,
is treated as one character.
-LPAD is a Trafodion SQL extension.
+LPAD is a {project-name} SQL extension.
```
LPAD (str, len [,padstr])
@@ -4113,7 +4113,7 @@ The LTRIM function removes leading spaces from a character string. If
you must remove any leading character other than space, use the TRIM
function and specify the value of the character. See the <<trim_function,TRIM Function>>.
-LTRIM is a Trafodion SQL extension.
+LTRIM is a {project-name} SQL extension.
```
LTRIM (character-expression)
@@ -4278,7 +4278,7 @@ The MINUTE function converts a TIME or TIMESTAMP expression into an
INTEGER value, in the range 0 through 59, that represents the
corresponding minute of the hour.
-MINUTE is a Trafodion SQL extension.
+MINUTE is a {project-name} SQL extension.
```
MINUTE (datetime-expression)
@@ -4312,7 +4312,7 @@ Start/Date Time/Shipped (EXPR)
The MOD function returns the remainder (modulus) of an integer value
expression divided by an integer value expression.
-MOD is a Trafodion SQL extension.
+MOD is a {project-name} SQL extension.
```
MOD (integer-expression-1,integer-expression-2)
@@ -4348,7 +4348,7 @@ The MONTH function converts a DATE or TIMESTAMP expression into an
INTEGER value in the range 1 through 12 that represents the
corresponding month of the year.
-MONTH is a Trafodion SQL extension.
+MONTH is a {project-name} SQL extension.
```
MONTH (datetime-expression)
@@ -4382,7 +4382,7 @@ The MONTHNAME function converts a DATE or TIMESTAMP expression into a
character literal that is the name of the month of the year (January,
February, and so on).
-MONTHNAME is a Trafodion SQL extension.
+MONTHNAME is a {project-name} SQL extension.
```
MONTHNAME (datetime-expression)
@@ -4423,7 +4423,7 @@ of non-null values of a column in the current window of an intermediate
result table ordered by a SEQUENCE BY clause in a SELECT statement. See
<<sequence_by_clause,SEQUENCE BY Clause>>.
-MOVINGAVG is a Trafodion SQL extension.
+MOVINGAVG is a {project-name} SQL extension.
```
MOVINGAVG(column-expression, integer-expression [, max-rows])
@@ -4501,7 +4501,7 @@ of non-null values of a column in the current window of an intermediate
result table ordered by a SEQUENCE BY clause in a SELECT statement. See
<<sequence_by_clause,SEQUENCE BY Clause>>.
-MOVINGCOUNT is a Trafodion SQL extension.
+MOVINGCOUNT is a {project-name} SQL extension.
```
MOVINGCOUNT (column-expression, integer-expression [, max-rows])
@@ -4578,7 +4578,7 @@ of non-null values of a column in the current window of an intermediate
result table ordered by a SEQUENCE BY clause in a SELECT statement. See
<<sequence_by_clause,SEQUENCE BY Clause>>.
-MOVINGMAX is a Trafodion SQL extension.
+MOVINGMAX is a {project-name} SQL extension.
```
MOVINGMAX (column-expression, integer-expression [, max-rows])
@@ -4647,7 +4647,7 @@ of non-null values of a column in the current window of an intermediate
result table ordered by a SEQUENCE BY clause in a SELECT statement. See
<<sequence_by_clause,SEQUENCE BY Clause>>.
-MOVINGMIN is a Trafodion SQL extension.
+MOVINGMIN is a {project-name} SQL extension.
```
MOVINGMIN (column-expression, integer-expression [, max-rows])
@@ -4716,7 +4716,7 @@ standard deviation of non-null values of a column in the current window
of an intermediate result table ordered by a SEQUENCE BY clause in a
SELECT statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-MOVINGSTDDEV is a Trafodion SQL extension.
+MOVINGSTDDEV is a {project-name} SQL extension.
```
MOVINGSTDDEV (column-expression, integer-expression [, max-rows])
@@ -4802,7 +4802,7 @@ non-null values of a column in the current window of an intermediate
result table ordered by a SEQUENCE BY clause in a SELECT statement. See
<<sequence_by_clause,SEQUENCE BY Clause>>.
-MOVINGSUM is a Trafodion SQL extension.
+MOVINGSUM is a {project-name} SQL extension.
```
MOVINGSUM (column-expression, integer-expression [, max-rows])
@@ -4871,7 +4871,7 @@ variance of non-null values of a column in the current window of an
intermediate result table ordered by a SEQUENCE BY clause in a SELECT
statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-MOVINGVARIANCE is a Trafodion SQL extension.
+MOVINGVARIANCE is a {project-name} SQL extension.
```
MOVINGVARIANCE (column-expression, integer-expression [, max-rows])
@@ -5055,7 +5055,7 @@ If _operand_ is a null value, NVL returns _new-operand_. If _operand_
is not a null value, NVL returns _operand_.
The _operand_ and _new-operand_ can be a column name, subquery,
-Trafodion SQL string functions, math functions, or constant values.
+{project-name} SQL string functions, math functions, or constant values.
[[examples_of_nvl]]
=== Examples of NVL
@@ -5123,8 +5123,8 @@ OCTET_LENGTH (string-value-expression)
* `_string-value-expression_`
+
specifies the string value expression for which to return the length in
-bytes. Trafodion SQL returns the result as a 2-byte signed integer with
-a scale of zero. If _string-value-expression_ is null, Trafodion SQL returns
+bytes. {project-name} SQL returns the result as a 2-byte signed integer with
+a scale of zero. If _string-value-expression_ is null, {project-name} SQL returns
a length of zero.
See <<character_value_expressions,Character Value Expressions>>.
@@ -5134,9 +5134,9 @@ See <<character_value_expressions,Character Value Expressions>>.
[[char_and_varchar_operands_1]]
==== CHAR and VARCHAR Operands
-For a column declared as fixed CHAR, Trafodion SQL returns the length of
+For a column declared as fixed CHAR, {project-name} SQL returns the length of
that column as the maximum number of storage bytes. For a VARCHAR
-column, Trafodion SQL returns the length of the string stored in that
+column, {project-name} SQL returns the length of the string stored in that
column as the actual number of storage bytes.
[[similarity_to_char_length_function]]
@@ -5221,7 +5221,7 @@ current row does not fall within the result table.
The PI function returns the constant value of pi as a floating-point
value.
-PI is a Trafodion SQL extension.
+PI is a {project-name} SQL extension.
```
PI()
@@ -5241,7 +5241,7 @@ PI()
== POSITION Function
The POSITION function searches for a given substring in a character
-string. If the substring is found, Trafodion SQL returns the character
+string. If the substring is found, {project-name} SQL returns the character
position of the substring within the string. Every character, including
multi-byte characters, is treated as one character. The result returned
by the POSITION function is equal to the result returned by the
@@ -5263,9 +5263,9 @@ is an SQL character value expression that specifies the source string.
the _source-expression_ cannot be null.
See <<character_value_expressions,Character Value Expressions>>.
-Trafodion SQL returns the result as a 2-byte signed integer with a scale
+{project-name} SQL returns the result as a 2-byte signed integer with a scale
of zero. If _substring-expression_ is not found in _source-expression_,
-Trafodion SQL returns zero.
+{project-name} SQL returns zero.
[[considerations_for_position]]
=== Considerations for POSITION
@@ -5274,12 +5274,12 @@ Trafodion SQL returns zero.
==== Result of POSITION
If the length of _source-expression_ is zero and the length of
-_substring-expression_ is greater than zero, Trafodion SQL returns 0. If
-the length of _substring-expression_ is zero, Trafodion SQL returns 1.
+_substring-expression_ is greater than zero, {project-name} SQL returns 0. If
+the length of _substring-expression_ is zero, {project-name} SQL returns 1.
If the length of _substring-expression_ is greater than the length of
-_source-expression_, Trafodion SQL returns zero. If
-_source-expression_ is a null value, Trafodion SQL returns a null value.
+_source-expression_, {project-name} SQL returns zero. If
+_source-expression_ is a null value, {project-name} SQL returns a null value.
[[using_the_upshift_function]]
==== Using the UPSHIFT Function
@@ -5315,7 +5315,7 @@ The POWER function returns the value of a numeric value expression
raised to the power of an integer value expression. You can also use the
exponential operator \*\*.
-POWER is a Trafodion SQL extension.
+POWER is a {project-name} SQL extension.
```
POWER (numeric-expression-1, numeric-expression-2)
@@ -5357,7 +5357,7 @@ INTEGER value in the range 1 through 4 that represents the corresponding
quarter of the year. Quarter 1 represents January 1 through March 31,
and so on.
-QUARTER is a Trafodion SQL extension.
+QUARTER is a {project-name} SQL extension.
```
QUARTER (datetime-expression)
@@ -5390,7 +5390,7 @@ Start/Date Time/Shipped (EXPR)
The RADIANS function converts a numeric value expression (expressed in
degrees) to the number of radians.
-RADIANS is a Trafodion SQL extension.
+RADIANS is a {project-name} SQL extension.
```
RADIANS (numeric-expression)
@@ -5427,7 +5427,7 @@ rank of the given value of an intermediate result table ordered by a
SEQUENCE BY clause in a SELECT statement. RANK is an alternative syntax
for RANK/RUNNINGRANK.
-RANK/RUNNINGRANK is a Trafodion extension.
+RANK/RUNNINGRANK is a {project-name} extension.
```
RUNNINGRANK(expression) | RANK(expression)
@@ -5606,7 +5606,7 @@ The REPEAT function returns a character string composed of the
evaluation of a character expression repeated a specified number of
times.
-REPEAT is a Trafodion SQL extension.
+REPEAT is a {project-name} SQL extension.
```
REPEAT (character-expr, count)
@@ -5645,7 +5645,7 @@ a specified character string in the original string are replaced with
another character string. All three character value expressions must be
comparable types. The return value is the VARCHAR type.
-REPLACE is a Trafodion SQL extension.
+REPLACE is a {project-name} SQL extension.
```
REPLACE (char-expr-1, char-expr-2, char-expr-3)
@@ -5701,7 +5701,7 @@ The RIGHT function returns the rightmost specified number of characters
from a character expression. Every character, including multi-byte
characters, is treated as one character.
-RIGHT is a Trafodion SQL extension.
+RIGHT is a {project-name} SQL extension.
```
RIGHT (character-expr, count)
@@ -5746,7 +5746,7 @@ SET jobdesc = RIGHT (jobdesc, 12);
The ROUND function returns the value of _numeric_expr_ rounded to _num_
places to the right of the decimal point.
-ROUND is a Trafodion SQL extension.
+ROUND is a {project-name} SQL extension.
```
ROUND(numeric-expr [ , num ] )
@@ -5830,7 +5830,7 @@ of rows counted since the specified condition was last true in the
intermediate result table ordered by a SEQUENCE BY clause in a SELECT
statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-Rows since is a Trafodion SQL extension.
+Rows since is a {project-name} SQL extension.
```
ROWS_SINCE [INCLUSIVE] (condition [, max-rows])
@@ -5872,7 +5872,7 @@ condition is evaluated starting with the previous row as row 1.
If a row is reached where the condition is true, ROWS SINCE returns the
number of rows counted so far. Otherwise, if the condition is never true
within the result table being considered, ROWS SINCE returns null.
-Trafodion SQL then goes to the next row as the new current row.
+{project-name} SQL then goes to the next row as the new current row.
[[examples_of_rows_since]]
=== Examples of ROWS SINCE
@@ -5920,7 +5920,7 @@ number of rows counted since the specified set of values last changed in
the intermediate result table ordered by a SEQUENCE BY clause in a
SELECT statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-ROWS SINCE CHANGED is a Trafodion SQL extension.
+ROWS SINCE CHANGED is a {project-name} SQL extension.
```
ROWS SINCE CHANGED (column-expression-list)
@@ -5971,7 +5971,7 @@ The RPAD function pads the right side of a string with the specified
string. Every character in the string, including multi-byte characters,
is treated as one character.
-RPAD is a Trafodion SQL extension.
+RPAD is a {project-name} SQL extension.
```
RPAD (str, len [, padstr])
@@ -6042,7 +6042,7 @@ you must remove any leading character other than space, use the TRIM
function and specify the value of the character.
See the <<trim_function,TRIM Function>>.
-RTRIM is a Trafodion SQL extension.
+RTRIM is a {project-name} SQL extension.
```
RTRIM (character-expression)
@@ -6084,7 +6084,7 @@ of non-null values of a column up to and including the current row of an
intermediate result table ordered by a SEQUENCE BY clause in a SELECT
statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-RUNNINGAVG is a Trafodion SQL extension.
+RUNNINGAVG is a {project-name} SQL extension.
```
RUNNINGAVG (_column-expression_)
@@ -6140,7 +6140,7 @@ of rows up to and including the current row of an intermediate result
table ordered by a SEQUENCE BY clause in a SELECT statement. See
<<sequence_by_clause,SEQUENCE BY Clause>>.
-RUNNINGCOUNT is a Trafodion SQL extension.
+RUNNINGCOUNT is a {project-name} SQL extension.
```
RUNNINGCOUNT {(*) | (column-expression)}
@@ -6202,7 +6202,7 @@ of values of a column up to and including the current row of an
intermediate result table ordered by a SEQUENCE BY clause in a SELECT
statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-RUNNINGMAX is a Trafodion SQL extension.
+RUNNINGMAX is a {project-name} SQL extension.
```
RUNNINGMAX (column-expression)
@@ -6246,7 +6246,7 @@ of values of a column up to and including the current row of an
intermediate result table ordered by a SEQUENCE BY clause in a SELECT
statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-RUNNINGMIN is a Trafodion SQL extension.
+RUNNINGMIN is a {project-name} SQL extension.
```
RUNNINGMIN (column-expression)
@@ -6290,7 +6290,7 @@ current row of an intermediate result table ordered by a SEQUENCE BY
clause in a SELECT statement.
See <<sequence_by_clause,SEQUENCE BY Clause>>.
-RUNNINGSTDDEV is a Trafodion SQL extension.
+RUNNINGSTDDEV is a {project-name} SQL extension.
```
RUNNINGSTDDEV (_column-expression_)
@@ -6364,7 +6364,7 @@ non-null values of a column up to and including the current row of an
intermediate result table ordered by a SEQUENCE BY clause in a SELECT
statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-RUNNINGSUM is a Trafodion SQL extension.
+RUNNINGSUM is a {project-name} SQL extension.
```
RUNNINGSUM (column-expression)
@@ -6408,7 +6408,7 @@ variance of non-null values of a column up to and including the current
row of an intermediate result table ordered by a SEQUENCE BY clause in a
SELECT statement. See <<sequence_by_clause,SEQUENCE BY Clause>>.
-RUNNINGVARIANCE is a Trafodion SQL extension.
+RUNNINGVARIANCE is a {project-name} SQL extension.
```
RUNNINGVARIANCE (column-expression)
@@ -6469,7 +6469,7 @@ The SECOND function converts a TIME or TIMESTAMP expression into an
INTEGER value in the range 0 through 59 that represents the
corresponding second of the hour.
-SECOND is a Trafodion SQL extension.
+SECOND is a {project-name} SQL extension.
```
SECOND (datetime-expression)
@@ -6505,7 +6505,7 @@ expression. If the value is less than zero, the function returns -1 as
the indicator. If the value is zero, the function returns 0. If the
value is greater than zero, the function returns 1.
-SIGN is a Trafodion SQL extension.
+SIGN is a {project-name} SQL extension.
```
SIGN (numeric-expression)
@@ -6545,7 +6545,7 @@ SIGN(-20 + 22)
The SIN function returns the SINE of a numeric value expression, where
the expression is an angle expressed in radians.
-SIN is a Trafodion SQL extension.
+SIN is a {project-name} SQL extension.
```
SIN (numeric-expression)
@@ -6574,7 +6574,7 @@ SIN (0.3491)
The SINH function returns the hyperbolic sine of a numeric value
expression, where the expression is an angle expressed in radians.
-SINH is a Trafodion SQL extension.
+SINH is a {project-name} SQL extension.
```
SINH (numeric-expression)
@@ -6604,7 +6604,7 @@ The SPACE function returns a character string consisting of a specified
number of spaces, each of which is 0x20 or 0x0020, depending on the
chosen character set.
-SPACE is a Trafodion SQL extension.
+SPACE is a {project-name} SQL extension.
```
SPACE (length [, char-set-name])
@@ -6639,7 +6639,7 @@ SPACE(3)
== SQRT Function
The SQRT function returns the square root of a numeric value expression.
-SQRT is a Trafodion SQL extension.
+SQRT is a {project-name} SQL extension.
```
SQRT (numeric-expression)
@@ -6666,7 +6666,7 @@ SQRT(27)
== STDDEV Function
STDDEV is an aggregate function that returns the standard deviation of a
-set of numbers. STDDEV is a Trafodion SQL extension.
+set of numbers. STDDEV is a {project-name} SQL extension.
```
STDDEV ([ALL | DISTINCT] expression [, weight])
@@ -6708,7 +6708,7 @@ root of the variance of the expression.
See <<variance_function,VARIANCE Function>>.
Because the definition of variance has _N-1_ in the denominator of the
-expression (if weight is not specified), Trafodion SQL returns a
+expression (if weight is not specified), {project-name} SQL returns a
system-defined default setting of zero (and no error) if the number of
rows in the table, or a group of the table, is equal to 1.
@@ -6828,7 +6828,7 @@ and continuing until the end of the _character-expr_ are returned.
=== Alternative Forms
* The SUBSTRING function treats SUBSTRING( _string_ FOR _int_ )
-equivalent to SUBSTRING( _string_ FROM 1 FOR _int_ ). The Trafodion
+equivalent to SUBSTRING( _string_ FROM 1 FOR _int_ ). The {project-name}
database software already supports the ANSI standard form as:
+
```
@@ -6836,7 +6836,7 @@ SUBSTRING(string FROM int [ FOR int ])
```
* The SUBSTRING function treats SUBSTRING (_string_, Fromint)
-equivalent to SUBSTRING(_string_ FROM _Fromint_). The Trafodion
+equivalent to SUBSTRING(_string_ FROM _Fromint_). The {project-name}
database software already supports SUBSTRING (_string_, _Fromint_,
_Forint_) as equivalent to the ANSI standard form:
+
@@ -6990,7 +6990,7 @@ SELECT SUM (price * qty_available) FROM sales.parts;
The TAN function returns the tangent of a numeric value expression,
where the expression is an angle expressed in radians.
-TAN is a Trafodion SQL extension.
+TAN is a {project-name} SQL extension.
```
TAN (numeric-expression)
@@ -7019,7 +7019,7 @@ TAN (0.3491)
The TANH function returns the hyperbolic tangent of a numeric value
expression, where the expression is an angle expressed in radians.
-TANH is a Trafodion SQL extension.
+TANH is a {project-name} SQL extension.
```
TANH (numeric-expression)
@@ -7051,7 +7051,7 @@ row and the value of the column in previous rows (in an intermediate
result table ordered by a SEQUENCE BY clause in a SELECT statement).
See <<rows_since_function,ROWS SINCE Function>>.
-THIS is a Trafodion SQL extension.
+THIS is a {project-name} SQL extension.
```
THIS (column-expression)
@@ -7083,7 +7083,7 @@ rows or the size of the result table).
If a row is reached where the condition is true, ROWS SINCE returns the
number of rows counted so far. Otherwise, if the condition is never true
within the result table being considered, ROWS SINCE returns null.
-Trafodion SQL then goes to the next row as the new current row and the
+{project-name} SQL then goes to the next row as the new current row and the
THIS constant is reevaluated.
<<<
@@ -7120,7 +7120,7 @@ month. The type of the _datetime_expr_ is returned except when the
_interval-ind_ contains any time component, in which case a TIMESTAMP is
returned.
-TIMESTAMPADD is a Trafodion SQL extension.
+TIMESTAMPADD is a {project-name} SQL extension.
```
TIMESTAMPADD (interval-ind, num-expr, datetime-expr)
@@ -7308,28 +7308,28 @@ is one of these translation names:
|===
| Translation Name | Source Character Set | Target Character Set | Comments
| ISO88591TOUTF8 | ISO88591 | UTF8 | Translates ISO8859-1 characters to UTF8 characters. No data loss is possible.
-| UTF8TOISO88591 | UTF8 | ISO88591 | Translates UTF8 characters to ISO88591 characters. Trafodion SQL will
+| UTF8TOISO88591 | UTF8 | ISO88591 | Translates UTF8 characters to ISO88591 characters. {project-name} SQL will
display an error if it encounters a Unicode character that cannot be converted to the target character set.
|===
_translation-name_ identifies the translation, source and target
character set. When you translate to the UTF8 character set, no data
-loss is possible. However, when Trafodion SQL translates a
+loss is possible. However, when {project-name} SQL translates a
_character-value-expression_ from UTF8, it may be that certain
-characters cannot be converted to the target character set. Trafodion
+characters cannot be converted to the target character set. {project-name}
SQL reports an error in this case.
-Trafodion SQL returns a variable-length character string with character
+{project-name} SQL returns a variable-length character string with character
repertoire equal to the character repertoire of the target character set
of the translation and the maximum length equal to the fixed length or
maximum variable length of the source _character-value-expression_.
-If you enter an illegal _translation-name_, Trafodion SQL returns an
+If you enter an illegal _translation-name_, {project-name} SQL returns an
error.
If the character set for _character-value-expression_ is different from
the source character set as specified in the _translation-name_,
-Trafodion SQL returns an error.
+{project-name} SQL returns an error.
<<<
[[trim_function]]
@@ -7411,7 +7411,7 @@ or <<upshift_function,UPSHIFT Function>>.
UCASE returns a string of fixed-length or variable-length character
data, depending on the data type of the input string.
-UCASE is a Trafodion SQL extension.
+UCASE is a {project-name} SQL extension.
```
UCASE (character-expression)
@@ -7523,7 +7523,7 @@ to the result returned by the <<upper_function,UPPER Function>> or
UPSHIFT returns a string of fixed-length or variable-length character
data, depending on the data type of the input string.
-UPSHIFT is a Trafodion SQL extension.
+UPSHIFT is a {project-name} SQL extension.
```
UPSHIFT (character-expression)
@@ -7643,7 +7643,7 @@ DB ROOT
== VARIANCE Function
VARIANCE is an aggregate function that returns the statistical variance
-of a set of numbers. VARIANCE is a Trafodion SQL extension.
+of a set of numbers. VARIANCE is a {project-name} SQL extension.
```
VARIANCE ([ALL | DISTINCT] expression [, weight])
@@ -7701,7 +7701,7 @@ expressed in the common data type, and N is the cardinality of the
result table.
Because the definition of variance has _N-1_ in the denominator of the
-expression (when weight is not specified), Trafodion SQL returns a
+expression (when weight is not specified), {project-name} SQL returns a
default value of zero (and no error) if the number of rows in the table,
or a group of the table, is equal to 1.
@@ -7795,7 +7795,7 @@ Sunday of the year. The value 53 is returned for datetimes that occur in
the last full or partial week of the year except for leap years that
start on Saturday where December 31 is in the 54th full or partial week.
-WEEK is a Trafodion SQL extension.
+WEEK is a {project-name} SQL extension.
```
WEEK (datetime-expression)
@@ -7829,7 +7829,7 @@ Start/Date Time/Shipped (EXPR)
The YEAR function converts a DATE or TIMESTAMP expression into an
INTEGER value that represents the year.
-YEAR is a Trafodion SQL extension.
+YEAR is a {project-name} SQL extension.
```
YEAR (datetime-expression)
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/sql_language_elements.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/sql_language_elements.adoc b/docs/sql_reference/src/asciidoc/_chapters/sql_language_elements.adoc
index 3124da8..e00218d 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/sql_language_elements.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/sql_language_elements.adoc
@@ -20,13 +20,13 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[sql_language_elements]]
= SQL Language Elements
-Trafodion SQL language elements, which include data types, expressions, functions, identifiers, literals, and
+{project-name} SQL language elements, which include data types, expressions, functions, identifiers, literals, and
predicates, occur within the syntax of SQL statements. The statement and command topics support the syntactical
and semantic descriptions of the language elements in this section.
@@ -143,7 +143,7 @@ statement omits a value for a particular column.
An SQL constraint is an object that protects the integrity of data in a table by specifying a condition that all the
values in a particular column or set of columns of the table must satisfy.
-Trafodion SQL enforces these constraints on SQL tables:
+{project-name} SQL enforces these constraints on SQL tables:
[cols="20%,80%"]
|===
@@ -163,22 +163,22 @@ one occurrence of the same value or set of values.
To create constraints on an SQL table when you create the table, use the NOT NULL, UNIQUE, CHECK, FOREIGN KEY, or
PRIMARY KEY clause of the CREATE TABLE statement.
-For more information on Trafodion SQL commands, see <<create_table_statement,CREATE TABLE Statement>> and
+For more information on {project-name} SQL commands, see <<create_table_statement,CREATE TABLE Statement>> and
<<alter_table_statement,ALTER TABLE Statement>>.
[[constraint_names]]
=== Constraint Names
-When you create a constraint, you can specify a name for it or allow a name to be generated by Trafodion SQL.
+When you create a constraint, you can specify a name for it or allow a name to be generated by {project-name} SQL.
You can optionally specify both column and table constraint names. Constraint names are ANSI logical names.
See <<database_object_names,Database Object Names>>. Constraint names are in the same name space as tables and
views, so a constraint name cannot have the same name s a table or view.
The name you specify can be fully qualified or not. If you specify the schema parts of the name, they must match
those parts of the affected table and must be unique among table, view, and constraint names in that schema. If you
-omit the schema portion of the name you specify, Trafodion SQL expands the name by using the schema for the table.
+omit the schema portion of the name you specify, {project-name} SQL expands the name by using the schema for the table.
-If you do not specify a constraint name, Trafodion SQL constructs an SQL identifier as the name for the constraint
+If you do not specify a constraint name, {project-name} SQL constructs an SQL identifier as the name for the constraint
and qualifies it with the schema of the table. The identifier consists of the table name concatenated with a
system-generated unique identifier.
@@ -235,8 +235,8 @@ WHERE orders.custnum = c.custnum AND orders.custnum = 543;
[[database_objects]]
== Database Objects
-A database object is an SQL entity that exists in a name space. SQL statements can access Trafodion SQL database objects.
-The subsections listed below describe these Trafodion SQL database objects.
+A database object is an SQL entity that exists in a name space. SQL statements can access {project-name} SQL database objects.
+The subsections listed below describe these {project-name} SQL database objects.
* <<constraints,Constraints>>
* <<indexes,Indexes>>
@@ -246,7 +246,7 @@ The subsections listed below describe these Trafodion SQL database objects.
[[ownership]]
=== Ownership
-In Trafodion SQL, the creator of an object owns the object defined in the schema and has all privileges on the object.
+In {project-name} SQL, the creator of an object owns the object defined in the schema and has all privileges on the object.
In addition, you can use the GRANT and REVOKE statements to grant access privileges for a table or view to specified users.
For more information, see the <<grant_statement,GRANT Statement>> and <<revoke_statement,REVOKE Statement>>. For
@@ -256,7 +256,7 @@ information on privileges on tables and views, see <<create_table_statement,CREA
[[database_object_names]]
== Database Object Names
-DML statements can refer to Trafodion SQL database objects. To refer to a database object in a statement, use an appropriate
+DML statements can refer to {project-name} SQL database objects. To refer to a database object in a statement, use an appropriate
database object name. For information on the types of database objects see <<database_objects,Database Objects>>.
<<<
@@ -270,25 +270,25 @@ logical name, also called an ANSI name:
catalog-name.schema-name.object-name
```
-In this three-part name, _catalog-name_ is the name of the catalog, which is TRAFODION for Trafodion SQL objects that map to
+In this three-part name, _catalog-name_ is the name of the catalog, which is TRAFODION for {project-name} SQL objects that map to
HBase tables. _schema-name_ is the name of the schema, and _object-name_ is the simple name of the table, view, constraint,
library, function, or procedure. Each of the parts is an SQL identifier. See <<identifiers,Identifiers>>.
-Trafodion SQL automatically qualifies an object name with a schema name unless you explicitly specify schema names with the
+{project-name} SQL automatically qualifies an object name with a schema name unless you explicitly specify schema names with the
object name. If you do not set a schema name for the session using a SET SCHEMA statement, the default schema is SEABASE,
which exists in the TRAFODION catalog. See <<set_schema_statement,SET SCHEMA Statement>>. A one-part name _object-name_ is
qualified implicitly with the default schema.
-You can qualify a column name in a Trafodion SQL statement by using a three-part, two-part, or one-part object name, or a
+You can qualify a column name in a {project-name} SQL statement by using a three-part, two-part, or one-part object name, or a
correlation name.
[[sql_object_namespaces]]
=== SQL Object Namespaces
-Trafodion SQL objects are organized in a hierarchical manner. Database objects exist in schemas, which are themselves
+{project-name} SQL objects are organized in a hierarchical manner. Database objects exist in schemas, which are themselves
contained in a catalog called TRAFODION. A catalog is a collection of schemas. Schema names must be unique within the catalog.
-Multiple objects with the same name can exist provided that each belongs to a different name space. Trafodion SQL supports these
+Multiple objects with the same name can exist provided that each belongs to a different name space. {project-name} SQL supports these
namespaces:
* Index
@@ -304,7 +304,7 @@ unique names within a given schema.
[[data_types]]
== Data Types
-Trafodion SQL data types are character, datetime, interval, or numeric (exact or approximate):
+{project-name} SQL data types are character, datetime, interval, or numeric (exact or approximate):
[cols="2*"]
|===
@@ -318,7 +318,7 @@ hours, minutes, seconds, and fractions of a second).
Each column in a table is associated with a data type. You can use the CAST expression to convert data to the data type that you specify. For
more information, see <<cast_expression,CAST Expression>>.
-The following table summarizes the Trafodion SQL data types:
+The following table summarizes the {project-name} SQL data types:
[cols="13%,29%,29%,29%",options="header"]
|===
@@ -427,7 +427,7 @@ Two data types are comparable if a value of one data type can be compared to a v
Two data types are compatible if a value of one data type can be assigned to a column of the other data type, and if
columns of the two data types can be combined using arithmetic operations. Compatible data types are also comparable.
-Assignment and comparison are the basic operations of Trafodion SQL. Assignment operations are performed during the
+Assignment and comparison are the basic operations of {project-name} SQL. Assignment operations are performed during the
execution of INSERT and UPDATE statements. Comparison operations are performed during the execution of statements that
include predicates, aggregate (or set) functions, and GROUP BY, HAVING, and ORDER BY clauses.
@@ -493,7 +493,7 @@ temporary copy of the integer converted to a decimal.
[[extended_numeric_precision]]
===== Extended Numeric Precision
-Trafodion SQL provides support for extended numeric precision data type. Extended numeric precision is an extension to
+{project-name} SQL provides support for extended numeric precision data type. Extended numeric precision is an extension to
the NUMERIC(x,y) data type where no theoretical limit exists on precision. It is a software data type, which means that
the underlying hardware does not support it and all computations are performed by software. Computations using this data
type may not match the performance of other hardware supported data types.
@@ -610,7 +610,7 @@ CREATE TABLE SCH.T
[[character_string_data_types]]
=== Character String Data Types
-Trafodion SQL includes both fixed-length character data and variable-length character data. You cannot compare character data to
+{project-name} SQL includes both fixed-length character data and variable-length character data. You cannot compare character data to
numeric, datetime, or interval data.
* `_character-type_` is:
@@ -695,7 +695,7 @@ characters are stored logically\u2014without blank padding.
[[nchar_columns_in_sql_tables]]
===== NCHAR Columns in SQL Tables
-In Trafodion SQL, the NCHAR type specification is equivalent to:
+In {project-name} SQL, the NCHAR type specification is equivalent to:
* NATIONAL CHARACTER
@@ -705,7 +705,7 @@ In Trafodion SQL, the NCHAR type specification is equivalent to:
Similarly, you can use NCHAR VARYING, NATIONAL CHARACTER VARYING, NATIONAL CHAR
VARYING, and VARCHAR … CHARACTER SET … , where the character set is
the character set for NCHAR. The character set for NCHAR is determined
-when Trafodion SQL is installed.
+when {project-name} SQL is installed.
<<<
[[datetime_data_types]]
@@ -723,8 +723,8 @@ value. For information on CAST, see <<cast
expression,CAST
Expression>>.
-Trafodion SQL accepts dates, such as October 5 to 14, 1582, that were
-omitted from the Gregorian calendar. This functionality is a Trafodion
+{project-name} SQL accepts dates, such as October 5 to 14, 1582, that were
+omitted from the Gregorian calendar. This functionality is a {project-name}
SQL extension.
The range of times that a datetime value can represent is:
@@ -733,7 +733,7 @@ The range of times that a datetime value can represent is:
January 1, 1 A.D., 00:00:00.000000 (low value) December 31, 9999, 23:59:59.999999 (high value)
```
-Trafodion SQL has three datetime data types:
+{project-name} SQL has three datetime data types:
* `_datetime-type_` is:
+
@@ -933,7 +933,7 @@ When you insert a fractional value into an INTERVAL data type field, if
the fractional value is 0 (zero) it does not cause an overflow.
Inserting value INTERVAL '1.000000' SECOND(6) into a field SECOND(0)
does not cause a loss of value. Provided that the value fits in the
-target column without a loss of precision, Trafodion SQL does not return
+target column without a loss of precision, {project-name} SQL does not return
an overflow error.
However, if the fractional value is > 0, an overflow occurs. Inserting
@@ -971,9 +971,9 @@ NUMERIC, SMALLINT, INTEGER, LARGEINT, and DECIMAL.
Approximate numeric data types are types that do not necessarily
represent a value exactly: FLOAT, REAL, and DOUBLE PRECISION.
+
-A column in a Trafodion SQL table declared with a floating-point data
+A column in a {project-name} SQL table declared with a floating-point data
type is stored in IEEE floating-point format and all computations on it
-are done assuming that. Trafodion SQL tables can contain only IEEE
+are done assuming that. {project-name} SQL tables can contain only IEEE
floating-point data.
* `NUMERIC [(_precision_ [,_scale_])] [SIGNED|UNSIGNED]`
@@ -1058,7 +1058,7 @@ is from +/- 2.2250738585072014e-308 through +/-1.7976931348623157e+308.
== Expressions
An SQL value expression, called an expression, evaluates to a value.
-Trafodion SQL supports these types of expressions:
+{project-name} SQL supports these types of expressions:
[cols="30%,70%"]
@@ -1365,7 +1365,7 @@ WHERE projcode = 920;
--- 1 row(s) selected.
```
+
-The result of adding 20 days to 2008-02-21 is 2008-03-12. Trafodion SQL
+The result of adding 20 days to 2008-02-21 is 2008-03-12. {project-name} SQL
correctly handles 2008 as a leap year.
* Subtract an interval value qualified by HOUR TO MINUTE from a datetime
@@ -1581,7 +1581,7 @@ INTERVAL '1' MONTH + INTERVAL '7' DAY
```
* If you multiply or divide an interval value by a numeric value
-expression, Trafodion SQL converts the interval value to its least
+expression, {project-name} SQL converts the interval value to its least
significant subfield and then multiplies or divides it by the numeric
value expression. The result has the same fields as the interval that
was multiplied or divided. For example, this expression returns the
@@ -1739,7 +1739,7 @@ maximum precision for the REAL data type is approximately 7 decimal
digits, and the maximum precision for the DOUBLE PRECISION data type is
approximately 16 digits.
-When Trafodion SQL encounters an arithmetic operator in an expression,
+When {project-name} SQL encounters an arithmetic operator in an expression,
it applies these rules (with the restriction that if the precision
becomes greater than 18, the resulting precision is set to 18 and the
resulting scale is the maximum of 0 and (18- (_resulted precision_ -
@@ -1766,7 +1766,7 @@ resulting magnitude is 4 plus 5 (or 9). The expression result is NUMERIC
[[conversion_of_numeric_types_for_arithmetic_operations]]
===== Conversion of Numeric Types for Arithmetic Operations
-Trafodion SQL automatically converts between floating-point numeric
+{project-name} SQL automatically converts between floating-point numeric
types (REAL and DOUBLE PRECISION) and other numeric types. All numeric
values in the expression are first converted to binary, with the maximum
precision needed anywhere in the evaluation.
@@ -1813,7 +1813,7 @@ word as a regular identifier.
Delimited identifiers are character strings that appear within double
quote characters (") and consist of alphanumeric characters, including
the underscore character (_) or a dash (-). Unlike regular identifiers,
-delimited identifiers are case-sensitive. Trafodion SQL does not support
+delimited identifiers are case-sensitive. {project-name} SQL does not support
spaces or special characters in delimited identifiers given the
constraints of the underlying HBase file system. You can use reserved
words as delimited identifiers.
@@ -1831,9 +1831,9 @@ or leading forward slash (/) character.
Unlike other delimited identifiers, case-insensitive-delimited
identifiers are case-insensitive. Identifiers are up-shifted before
being inserted into the SQL metadata. Thus, whether you specify a user's
-name as `"Penelope.Quan@hp.com"`, `"PENELOPE.QUAN@hp.com"`, or
-`"penelope.quan@hp.com"`, the value stored in the metadata will be the
-same: `PENELOPE.QUAN@HP.COM`.
+name as `"Penelope.Quan@company.com"`, `"PENELOPE.QUAN@company.com"`, or
+`"penelope.quan@company.com"`, the value stored in the metadata will be the
+same: `PENELOPE.QUAN@COMPANY.COM`.
You can use reserved words as case-insensitive delimited identifiers.
@@ -1887,7 +1887,7 @@ table rows.
[[sql_indexes]]
=== SQL Indexes
-Each row in a Trafodion SQL index contains:
+Each row in a {project-name} SQL index contains:
* The columns specified in the CREATE INDEX statement
* The clustering key of the underlying table (the user-defined
@@ -1908,7 +1908,7 @@ See <<create_index_statement,CREATE INDEX Statement>>.
=== Clustering Keys
Every table has a clustering key, which is the set of columns that
-determine the order of the rows on disk. Trafodion SQL organizes records
+determine the order of the rows on disk. {project-name} SQL organizes records
of a table or index by using a b-tree based on this clustering key.
Therefore, the values of the clustering key act as logical row-ids.
@@ -1920,8 +1920,8 @@ an additional column is appended to the _key-column-list_ called the
SYSKEY.
A SYSKEY (or system-defined clustering key) is a clustering key column
-which is defined by Trafodion SQL rather than by the user. Its type is
-LARGEINT SIGNED. When you insert a record in a table, Trafodion SQL
+which is defined by {project-name} SQL rather than by the user. Its type is
+LARGEINT SIGNED. When you insert a record in a table, {project-name} SQL
automatically generates a value for the SYSKEY column. You cannot supply
the value.
@@ -1937,7 +1937,7 @@ SELECT *, SYSKEY FROM t4;
=== Index Keys
A one-to-one correspondence always exists between index rows and base
-table rows. Each row in a Trafodion SQL index contains:
+table rows. Each row in a {project-name} SQL index contains:
* The columns specified in the CREATE INDEX statement
@@ -2004,7 +2004,7 @@ _ character-set_`
specifies the character set ISO88591 or UTF8. The _character-set_
specification of the string literal should correspond with the character
set of the column definition, which is either ISO88591 or UTF8. If you
-omit the _character-set specification, Trafodion SQL initially assumes
+omit the _character-set specification, {project-name} SQL initially assumes
the ISO88591 character set if the string literal consists entirely of
7-bit ASCII characters and UTF8 otherwise. (However, the initial
assumption will later be changed if the string literal is used in a
@@ -2015,7 +2015,7 @@ assumption.)
+
associates the string literal with the character set of the NATIONAL
CHARACTER (NCHAR) data type. The character set for NCHAR is determined
-during the installation of Trafodion SQL. This value can be either UTF8
+during the installation of {project-name} SQL. This value can be either UTF8
(the default) or ISO88591.
<<<
@@ -2063,7 +2063,7 @@ When specifying string literals:
* Do not put a space between the character set qualifier and the
character string literal. If you use this character string literal in a
-statement, Trafodion SQL returns an error.
+statement, {project-name} SQL returns an error.
* To specify a single quotation mark within a string literal, use two
consecutive single quotation marks.
* To specify a string literal whose length is more than one line,
@@ -2409,7 +2409,7 @@ These are all numeric literals, along with their display format:
== Null
Null is a special symbol, independent of data type, that represents an
-unknown. The Trafodion SQL keyword NULL represents null. Null indicates
+unknown. The {project-name} SQL keyword NULL represents null. Null indicates
that an item has no value. For sorting purposes, null is greater than
all other values. You cannot store null in a column by using INSERT or
UPDATE, unless the column allows null.
@@ -2453,14 +2453,14 @@ primary key of the table.
Null is the default for a column (other than NOT NULL) unless the column
definition includes a DEFAULT clause (other than DEFAULT NULL) or the NO
-DEFAULT clause. The default value for a column is the value Trafodion
+DEFAULT clause. The default value for a column is the value {project-name}
SQL inserts in a row when an INSERT statement omits a value for a
particular column.
[[null_in_distinct_group_by_and_order_by_clauses]]
==== Null in DISTINCT, GROUP BY, and ORDER BY Clauses
-In evaluating the DISTINCT, GROUP BY, and ORDER BY clauses, Trafodion
+In evaluating the DISTINCT, GROUP BY, and ORDER BY clauses, {project-name}
SQL considers all nulls to be equal. Additional considerations for these
clauses are:
@@ -2718,7 +2718,7 @@ values with the same ordinal position in the two lists.) See
[[when_a_comparison_predicate_is_true]]
===== When a Comparison Predicate Is True
-Trafodion SQL determines whether a relationship is true or false by
+{project-name} SQL determines whether a relationship is true or false by
comparing values in corresponding positions in sequence, until it finds
the first non-equal pair.
@@ -2733,35 +2733,35 @@ X=(X1,X2,...,Xn), Y=(Y1,Y2,...,Yn).
```
Predicate X=Y is true if for all i=1,…,n: Xi=Yi. For this predicate,
-Trafodion SQL must look through all values. Predicate X = Y is false if
+{project-name} SQL must look through all values. Predicate X = Y is false if
for some i Xi<>Yi. When SQL finds non-equal components, it stops and does
not look at remaining components.
-Predicate X<>Y is true if X=Y is false. If X1<>Y1, Trafodion SQL does
+Predicate X<>Y is true if X=Y is false. If X1<>Y1, {project-name} SQL does
not look at all components. It stops and returns a value of false for
the X=Y predicate and a value of true for the X<>Y predicate. Predicate
X<>Y is false if X=Y is true, or for all i=1,…,n: Xi=Yi. In this
-situation, Trafodion SQL must look through all components.
+situation, {project-name} SQL must look through all components.
Predicate X>Y is true if for some index m Xm>Ym and for all i=1,…,m-1:
-Xi=Yi. Trafodion SQL does not look through all components. It stops when
+Xi=Yi. {project-name} SQL does not look through all components. It stops when
it finds the first nonequal components, Xm<>Ym. If Xm>Ym, the predicate
is true. Otherwise the predicate is false. The predicate is also false
if all components are equal, or X=Y.
Predicate X>=Y is true if X>Y is true or X=Y is true. In this scenario,
-Trafodion SQL might look through all components and return true if they
+{project-name} SQL might look through all components and return true if they
are all equal. It stops at the first nonequal components, Xm<>Ym. If
Xm>Ym, the predicate is true. Otherwise, it is false.
Predicate X<Y is true if for some index m Xm<Ym, and for all i=1,…,m-1:
-Xi=Yi. Trafodion SQL does not look through all components. It stops when
+Xi=Yi. {project-name} SQL does not look through all components. It stops when
it finds the first nonequal components Xm<>Ym. If Xm<Ym, the predicate
is true. Otherwise, the predicate is false. The predicate is also false
if all components are equal, or X=Y.
Predicate X<=Y is true if X<Y is true or X=Y is true. In this scenario,
-Trafodion SQL might need to look through all components and return true
+{project-name} SQL might need to look through all components and return true
if they are all equal. It stops at the first non-equal components,
Xm<>Ym. If Xm<Ym, the predicate is true. Otherwise, it is false.
@@ -2773,9 +2773,9 @@ shorter string is padded on the right with spaces (HEX 20) until it is
the length of the longer string. Both fixed-length and
variable-length strings are padded in this way.
-For example, Trafodion SQL considers the string \u2018JOE\u2019 equal to a value
+For example, {project-name} SQL considers the string \u2018JOE\u2019 equal to a value
JOE stored in a column of data type CHAR or VARCHAR of width three or
-more. Similarly, Trafodion SQL considers a value JOE stored in any
+more. Similarly, {project-name} SQL considers a value JOE stored in any
column of the CHAR data type equal to the value JOE stored in any column
of the VARCHAR data type.
@@ -2791,10 +2791,10 @@ converted to the maximum precision needed anywhere in the expression.
[[comparing_interval_data]]
===== Comparing Interval Data
-For comparisons of INTERVAL values, Trafodion SQL first converts the
+For comparisons of INTERVAL values, {project-name} SQL first converts the
intervals to a common unit.
-If no common unit exists, Trafodion SQL reports an error. Two INTERVAL
+If no common unit exists, {project-name} SQL reports an error. Two INTERVAL
values must be both year-month intervals or both day-time intervals.
[[comparing_multiple_values]]
@@ -2872,7 +2872,7 @@ JOB1_TIME < JOB2_TIME
Suppose that JOB1_TIME, defined as INTERVAL DAY TO MINUTE, is 2 days 3
hours, and JOB2_TIME, defined as INTERVAL DAY TO HOUR, is 3 days.
+
-To evaluate the predicate, Trafodion SQL converts the two INTERVAL
+To evaluate the predicate, {project-name} SQL converts the two INTERVAL
values to MINUTE. The comparison predicate is true.
@@ -3129,9 +3129,9 @@ shorter string is padded on the right with spaces (HEX 20) until it is
the length of the longer string. Both fixed-length and varying-length
strings are padded in this way.
-For example, Trafodion SQL considers the string \u2018JOE\u2019 equal to a value
+For example, {project-name} SQL considers the string \u2018JOE\u2019 equal to a value
JOE stored in a column of data type CHAR or VARCHAR of width three or
-more. Similarly, Trafodion SQL considers a value JOE stored in any
+more. Similarly, {project-name} SQL considers a value JOE stored in any
column of the CHAR data type equal to the value JOE stored in any column
of the VARCHAR data type.
@@ -3144,10 +3144,10 @@ converted to the maximum precision needed anywhere in the expression.
[[comparing_interval_data]]
===== Comparing Interval Data
-For comparisons of INTERVAL values, Trafodion SQL first converts the
+For comparisons of INTERVAL values, {project-name} SQL first converts the
intervals to a common unit.
-If no common unit exists, Trafodion SQL reports an error. Two INTERVAL
+If no common unit exists, {project-name} SQL reports an error. Two INTERVAL
values must be both year-month intervals or both day-time intervals.
@@ -3312,7 +3312,7 @@ will be returned if this kind of pattern is used in an SQL query.
===== Comparing the Pattern to CHAR Columns
Columns of data type CHAR are fixed length. When a value is inserted
-into a CHAR column, Trafodion SQL pads the value in the column with
+into a CHAR column, {project-name} SQL pads the value in the column with
blanks if necessary. The value 'JOE' inserted into a CHAR(4) column
becomes 'JOE ' (three characters plus one blank). The LIKE predicate is
true only if the column value and the comparison value are the same
@@ -3730,17 +3730,17 @@ To manage roles, see these SQL statements:
== Schemas
The ANSI SQL:1999 schema name is an SQL identifier that is unique for a
-given ANSI catalog name. Trafodion SQL automatically qualifies the
+given ANSI catalog name. {project-name} SQL automatically qualifies the
schema name with the current default catalog name, TRAFODION.
The logical name of the form _schema.object_ is an ANSI name. The part
_schema_ denotes the ANSI-defined schema.
-To be compliant with ANSI SQL:1999, Trafodion SQL provides support for
+To be compliant with ANSI SQL:1999, {project-name} SQL provides support for
ANSI object names.
By using these names, you can develop ANSI-compliant applications that
-access all SQL objects. You can access Trafodion SQL objects with the
+access all SQL objects. You can access {project-name} SQL objects with the
name of the actual object. See <<set_schema_statement,SET SCHEMA Statement>>.
[[creating_and_dropping_schemas]]
@@ -3985,7 +3985,7 @@ represents the data value of a particular field in a particular record.
Every table must have one or more columns, but the number of rows can be
zero. No inherent order of rows exists within a table.
-You create a Trafodion SQL user table by using the CREATE TABLE
+You create a {project-name} SQL user table by using the CREATE TABLE
statement. See the <<create_table_statement,CREATE TABLE Statement>>.
The definition of a user table within the statement includes this information:
@@ -3996,22 +3996,22 @@ The definition of a user table within the statement includes this information:
characteristics of the file that stores the table (for example, the
storage order of rows within the table)
-A Trafodion SQL table is described in an SQL schema and stored as an
-HBase table. Trafodion SQL tables have regular ANSI names in the catalog
-TRAFODION. A Trafodion SQL table name can be a fully qualified ANSI name
-of the form TRAFODION._schema-name.object-name_. A Trafodion SQL
+A {project-name} SQL table is described in an SQL schema and stored as an
+HBase table. {project-name} SQL tables have regular ANSI names in the catalog
+TRAFODION. A {project-name} SQL table name can be a fully qualified ANSI name
+of the form TRAFODION._schema-name.object-name_. A {project-name} SQL
table\u2019s metadata is stored in the schema TRAFODION."_MD_".
-Because Trafodion defines the encodings for column values in Trafodion
-SQL tables, those tables support various Trafodion SQL statements. See
+Because {project-name} defines the encodings for column values in {project-name}
+SQL tables, those tables support various {project-name} SQL statements. See
<<supported_sql_statements_with_hbase_tables,Supported SQL Statements With HBase Tables>>.
-Internally, Trafodion SQL tables use a single HBase column family and
+Internally, {project-name} SQL tables use a single HBase column family and
shortened column names to conserve space. Their encoding allows keys
consisting of multiple columns and preserves the order of key values as
defined by SQL. The underlying HBase column model makes it very easy to
-add and remove columns from Trafodion SQL tables. HBase columns that are
-not recorded in the Trafodion metadata are ignored, and missing columns
+add and remove columns from {project-name} SQL tables. HBase columns that are
+not recorded in the {project-name} metadata are ignored, and missing columns
are considered NULL values.
[[base_tables_and_views]]
[22/22] incubator-trafodion git commit: Merge [TRAFODION-1949] PR 457
New JDBC Type 4 Programmer's Reference Guide
Posted by db...@apache.org.
Merge [TRAFODION-1949] PR 457 New JDBC Type 4 Programmer's Reference Guide
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/d79ef12b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/d79ef12b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/d79ef12b
Branch: refs/heads/master
Commit: d79ef12bad7bf1f476b38823cfe0751c1219071b
Parents: 5e17562 fc64477
Author: Dave Birdsall <db...@apache.org>
Authored: Thu May 5 23:38:23 2016 +0000
Committer: Dave Birdsall <db...@apache.org>
Committed: Thu May 5 23:38:23 2016 +0000
----------------------------------------------------------------------
docs/client_install/pom.xml | 10 +
.../src/asciidoc/_chapters/SQuirrel.adoc | 16 +-
.../src/asciidoc/_chapters/about.adoc | 16 +-
.../src/asciidoc/_chapters/dbviz.adoc | 12 +-
.../src/asciidoc/_chapters/introduction.adoc | 104 +-
.../src/asciidoc/_chapters/jdbct4.adoc | 32 +-
.../src/asciidoc/_chapters/odb.adoc | 8 +-
.../src/asciidoc/_chapters/odbc_linux.adoc | 18 +-
.../src/asciidoc/_chapters/odbc_windows.adoc | 54 +-
.../src/asciidoc/_chapters/trafci.adoc | 10 +-
docs/client_install/src/asciidoc/index.adoc | 28 +-
docs/command_interface/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 22 +-
.../src/asciidoc/_chapters/commands.adoc | 40 +-
.../src/asciidoc/_chapters/install.adoc | 4 +-
.../src/asciidoc/_chapters/interactive.adoc | 14 +-
.../src/asciidoc/_chapters/introduction.adoc | 6 +-
.../src/asciidoc/_chapters/launch.adoc | 16 +-
.../src/asciidoc/_chapters/perlpython.adoc | 6 +-
.../src/asciidoc/_chapters/scripts.adoc | 4 +-
docs/command_interface/src/asciidoc/index.adoc | 29 +-
docs/cqd_reference/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 23 +-
.../src/asciidoc/_chapters/debugging.adoc | 14 +-
.../src/asciidoc/_chapters/histograms.adoc | 16 +-
.../src/asciidoc/_chapters/introduction.adoc | 8 +-
.../_chapters/operational_controls.adoc | 26 +-
.../src/asciidoc/_chapters/query_execution.adoc | 46 +-
.../src/asciidoc/_chapters/query_plans.adoc | 78 +-
.../asciidoc/_chapters/runtime_controls.adoc | 6 +-
.../src/asciidoc/_chapters/schema_controls.adoc | 8 +-
.../asciidoc/_chapters/table_definition.adoc | 28 +-
.../src/asciidoc/_chapters/transactions.adoc | 6 +-
.../src/asciidoc/_chapters/update_stats.adoc | 14 +-
docs/cqd_reference/src/asciidoc/index.adoc | 21 +-
docs/jdbct4ref_guide/pom.xml | 297 +++
.../src/asciidoc/_chapters/about.adoc | 174 ++
.../src/asciidoc/_chapters/accessing.adoc | 906 ++++++++
.../asciidoc/_chapters/avoiding_mismatch.adoc | 97 +
.../src/asciidoc/_chapters/code_examples.adoc | 56 +
.../src/asciidoc/_chapters/compliance.adoc | 367 ++++
.../src/asciidoc/_chapters/introduction.adoc | 53 +
.../src/asciidoc/_chapters/lob_data.adoc | 553 +++++
.../src/asciidoc/_chapters/lob_management.adoc | 288 +++
.../src/asciidoc/_chapters/messages.adoc | 1943 ++++++++++++++++++
.../asciidoc/_chapters/properties_detail.adoc | 959 +++++++++
.../asciidoc/_chapters/properties_overview.adoc | 244 +++
.../src/asciidoc/_chapters/tracing_logging.adoc | 176 ++
docs/jdbct4ref_guide/src/asciidoc/index.adoc | 67 +
docs/jdbct4ref_guide/src/images/lob_tables.jpg | Bin 0 -> 16241 bytes
.../src/resources/source/blob_example.java | 202 ++
.../src/resources/source/clob_example.java | 200 ++
docs/load_transform/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 31 +-
.../src/asciidoc/_chapters/bulk_load.adoc | 34 +-
.../src/asciidoc/_chapters/bulk_unload.adoc | 12 +-
.../src/asciidoc/_chapters/introduction.adoc | 24 +-
.../src/asciidoc/_chapters/monitor.adoc | 8 +-
.../src/asciidoc/_chapters/tables_indexes.adoc | 24 +-
.../src/asciidoc/_chapters/trickle_load.adoc | 54 +-
.../src/asciidoc/_chapters/troubleshoot.adoc | 20 +-
docs/load_transform/src/asciidoc/index.adoc | 22 +-
docs/messages_guide/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 25 +-
.../src/asciidoc/_chapters/binder_msgs.adoc | 162 +-
.../src/asciidoc/_chapters/compiler_msgs.adoc | 164 +-
.../src/asciidoc/_chapters/ddl_msgs.adoc | 156 +-
.../src/asciidoc/_chapters/executor_msgs.adoc | 82 +-
.../asciidoc/_chapters/file_system_errors.adoc | 6 +-
.../src/asciidoc/_chapters/generator_msgs.adoc | 4 +-
.../src/asciidoc/_chapters/introduction.adoc | 34 +-
.../src/asciidoc/_chapters/optimizer_msgs.adoc | 6 +-
.../src/asciidoc/_chapters/parser_msgs.adoc | 74 +-
.../src/asciidoc/_chapters/sort_msgs.adoc | 68 +-
.../src/asciidoc/_chapters/sqlstate.adoc | 78 +-
.../_chapters/udr_language_mgr_msgs.adoc | 26 +-
docs/messages_guide/src/asciidoc/index.adoc | 21 +-
docs/odb_user/pom.xml | 8 +
.../src/asciidoc/_chapters/a_warnings.adoc | 4 +-
docs/odb_user/src/asciidoc/_chapters/about.adoc | 24 +-
.../src/asciidoc/_chapters/b_develop.adoc | 2 +-
.../src/asciidoc/_chapters/compare_tables.adoc | 2 +-
.../src/asciidoc/_chapters/concepts.adoc | 23 +-
.../src/asciidoc/_chapters/install.adoc | Bin 13598 -> 13248 bytes
.../src/asciidoc/_chapters/introduction.adoc | 36 +-
docs/odb_user/src/asciidoc/_chapters/load.adoc | 42 +-
.../src/asciidoc/_chapters/query_driver.adoc | 4 +-
.../src/asciidoc/_chapters/sql_interpreter.adoc | 4 +-
docs/odb_user/src/asciidoc/index.adoc | 21 +-
docs/provisioning_guide/pom.xml | 10 +
.../src/asciidoc/_chapters/about.adoc | 35 +-
.../src/asciidoc/_chapters/activate.adoc | 30 +-
.../src/asciidoc/_chapters/enable_security.adoc | 52 +-
.../src/asciidoc/_chapters/introduction.adoc | 184 +-
.../src/asciidoc/_chapters/prepare.adoc | 84 +-
.../src/asciidoc/_chapters/requirements.adoc | 125 +-
.../src/asciidoc/_chapters/script_install.adoc | 80 +-
.../src/asciidoc/_chapters/script_remove.adoc | 22 +-
.../src/asciidoc/_chapters/script_upgrade.adoc | 82 +-
docs/provisioning_guide/src/asciidoc/index.adoc | 22 +-
docs/shared/acknowledgements.txt | 60 +
docs/shared/revisions.txt | 32 +
.../spj_guide/src/asciidoc/_chapters/about.adoc | 2 +-
.../src/asciidoc/_chapters/create_spjs.adoc | 36 +-
.../src/asciidoc/_chapters/deploy_spjs.adoc | 34 +-
.../src/asciidoc/_chapters/develop_spjs.adoc | 36 +-
.../src/asciidoc/_chapters/execute_spjs.adoc | 34 +-
.../src/asciidoc/_chapters/get_started.adoc | 36 +-
.../asciidoc/_chapters/grant_privileges.adoc | 36 +-
.../src/asciidoc/_chapters/introduction.adoc | 36 +-
.../_chapters/performance_troubleshooting.adoc | 36 +-
.../src/asciidoc/_chapters/sample_database.adoc | 36 +-
.../src/asciidoc/_chapters/sample_spjs.adoc | 42 +-
docs/spj_guide/src/asciidoc/index.adoc | 14 +-
.../src/resources/acknowledgements.txt | 38 -
.../src/resources/source/create_demo.sql | 14 +
docs/sql_reference/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 48 +-
.../src/asciidoc/_chapters/introduction.adoc | 112 +-
.../src/asciidoc/_chapters/limits.adoc | 4 +-
.../src/asciidoc/_chapters/olap_functions.adoc | 19 +-
.../src/asciidoc/_chapters/reserved_words.adoc | 13 +-
.../src/asciidoc/_chapters/runtime_stats.adoc | 13 +-
.../src/asciidoc/_chapters/sql_clauses.adoc | 26 +-
.../sql_functions_and_expressions.adoc | 304 +--
.../_chapters/sql_language_elements.adoc | 160 +-
.../src/asciidoc/_chapters/sql_statements.adoc | 374 ++--
.../src/asciidoc/_chapters/sql_utilities.adoc | 84 +-
docs/sql_reference/src/asciidoc/index.adoc | 27 +-
docs/src/site/resources/css/site.css | 2 +-
130 files changed, 8817 insertions(+), 2287 deletions(-)
----------------------------------------------------------------------
[07/22] incubator-trafodion git commit: Incorporated more review
changes.
Posted by db...@apache.org.
Incorporated more review changes.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/716b92e3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/716b92e3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/716b92e3
Branch: refs/heads/master
Commit: 716b92e3d5f30a35487c39ae3f2e21b7d1bd710f
Parents: c5543bd
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Sun May 1 11:13:29 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Sun May 1 11:13:29 2016 -0600
----------------------------------------------------------------------
.../asciidoc/_chapters/properties_overview.adoc | 21 ++++++++--------
.../src/asciidoc/_chapters/tracing_logging.adoc | 25 +++-----------------
2 files changed, 13 insertions(+), 33 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/716b92e3/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc
index b44f0c9..7632e52 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/properties_overview.adoc
@@ -85,7 +85,7 @@ connections made through the ConnectionPoolDataSource object.) | -1 (Do not crea
[cols="25%,55%,30%",options="header" ]
|===
| Property Name | Description | Default Value
-| `<<T4LogFile, T4LogFile>>` | Sets the name of the logging file for the Type 4 driver. | The name is defined by the following pattern: `%h/hpt4jdbc%u.log`
+| `<<T4LogFile, T4LogFile>>` | Sets the name of the logging file for the Type 4 driver. | The name is defined by the following pattern: `%h/t4jdbc%u.log`
| `<<T4LogLevel, T4LogLevel>>` | Sets the logging levels that control logging output for the Type 4 driver. | OFF
|===
@@ -114,7 +114,7 @@ description, the particular property applies to the DataSource object,
|===
| Property Name | Description | Default Value
| `<<catalog, catalog>>` | Sets the default catalog used to access SQL objects referenced in SQL
-statements if the SQL objects are not fully qualified. | None. Must be "Seabase" in the current release.
+statements if the SQL objects are not fully qualified. | None. Must be "TRAFODION" in the current release.
| `<<connectionTimeout, connectionTimeout>>` | Sets the number of seconds a connection can be idle before the connection is physically closed by DCS. |
-1 (Use the ConnTimeout value set on the server data source.)
| `<<password, password>>` | Sets the password value for passing to the database. Can also change the password. | Empty string.
@@ -162,13 +162,13 @@ property file is passed as a java command-line parameter. The format to
enter the properties file in the command line is:
```
--Dhpt4jdbc.properties=<path of the properties file on disk>`
+-Dt4jdbc.properties=<path of the properties file on disk>`
```
*Example*
```
--Dhpt4jdbc.properties=C:\temp\t4props\myprops.properties
+-Dt4jdbc.properties=C:\temp\t4props\myprops.properties
```
To create the file, use the editor of your choice on your workstation to
@@ -189,11 +189,11 @@ To configure a `DataSource` connection, the properties file might contain
property names and values as indicated in the following list:
```
-url=jdbc:hpt4jdbc://<primary IP addr or host name of database>:37800/
+url=jdbc:t4jdbc://<primary IP addr or host name of database>:23400/
user=database_username
password=mypassword
description=<a string>
-catalog=Seabase
+catalog=TRAFODION
schema=myschema
maxPoolSize=20
minPoolSize=5
@@ -201,7 +201,6 @@ maxStatements=20
loginTimeout=15
initialPoolSize=10
connectionTimeout=10
-serverDataSource=server_data_source
T4LogLevel=OFF
T4LogFile=/mylogdirectory/mylogfile
```
@@ -210,7 +209,7 @@ T4LogFile=/mylogdirectory/mylogfile
=== Setting Properties in the Command Line
When a Type 4 driver property is specified on the command line through
-the java `-D` option, the property must include the prefix: `hpt4jdbc`.
+the java `-D` option, the property must include the prefix: `t4jdbc`.
This notation, which includes the period (.), ensures that all the Type
4 driver property names are unique for a Java application.
@@ -220,7 +219,7 @@ This notation, which includes the period (.), ensures that all the Type
The maxStatements property becomes:
```
--Dhpt4jdbc.maxStatements=10
+-Dt4jdbc.maxStatements=10
```
[[precedence-of-property-specifications]]
@@ -237,9 +236,9 @@ order of precedence:
method of `DriverManager` class.
3. Set the property in a properties file specified by the
-`hpt4jdbc.properties` property.
+`t4jdbc.properties` property.
-4. Set the `-Dhpt4jdbc.property_name=<property value>` in the java command line.
+4. Set the `-Dt4jdbc.property_name=<property value>` in the java command line.
For more information, see order of precedence for properties specified
in various ways for use with the Driver Manager.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/716b92e3/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
index 0d7cb9b..c52384e 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/tracing_logging.adoc
@@ -81,25 +81,6 @@ following additional information:
* Finer control over the amount and type of logging information
* Error and warning messages
-[[accessing-the-type-4-driver-logging-facility]]
-=== Accessing the Type 4 Driver Logging Facility
-
-The Type 4 Driver Logging facility is based on the `java.util.logging`
-package. The Type 4 driver instantiates a `java.util.logging.Logger` class
-and names the logger `org.trafodion.jdbc.t4.logger`.
-
-Your JDBC program can access the Type 4 driver logger directly by
-calling the `java.util.logging.Logger` static method `getLogger(String)`.
-
-*example*
-
-[source, java]
-----
-String t4Logger =
- java.util.logging.Logger.getLogger( "org.trafodion.jdbc.t4.logger" ) ;
-----
-
-<<<
[[controlling-type-4-driver-logging-output]]
=== Controlling Type 4 Driver Logging Output
@@ -143,7 +124,7 @@ sequence-number ~ time-stamp ~ thread-id
| `connection-id` | If applicable, a unique ID for the connection associated with the message.
| `server-id` | If applicable, information about the connectivity server associated with the message. The _server-id_ is of the form: +
+
-`TCP:node-name.server-name/port-number:HPODBC` +
+`TCP:node-name.server-name/port-number:ODBC` +
+
where +
+
@@ -153,7 +134,7 @@ where +
+
*Example* +
+
-`TCP:\banshee-tcp.$Z0133/46003:HPODBC`
+`TCP:\banshee-tcp.$Z0133/46003:ODBC`
| `dialogue-id` | If applicable, the `dialogue-id` used for the DCS connection.
| `class` | If applicable, the name of the class that issued the logging request.
| `method` | If applicable, the name of the method that issued the logging request.
@@ -177,7 +158,7 @@ zeros (0) to allow for readable formatting.
+
```
00000036 ~ Dec 8, 2006 10:05:55 AM PST ~ 10 ~ 4508606 ~ null
- ~ null ~ HPT4Messages.createSQLException("en_US",
+ ~ null ~ T4Messages.createSQLException("en_US",
"socket_write_error", "null") ~
```
[05/22] incubator-trafodion git commit: Merge remote-tracking branch
'origin/master' into TRAFODION-1949
Posted by db...@apache.org.
Merge remote-tracking branch 'origin/master' into TRAFODION-1949
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/09be4be3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/09be4be3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/09be4be3
Branch: refs/heads/master
Commit: 09be4be321258ace6154388ffcbf0f384dde698a
Parents: a3cc57d 64a68cf
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Sat Apr 30 12:51:44 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Sat Apr 30 12:51:44 2016 -0600
----------------------------------------------------------------------
core/conn/jdbc_type2/native/SqlInterface.cpp | 3 ---
core/conn/jdbc_type4/src/org/trafodion/jdbc/t4/SecPwd.java | 9 ---------
2 files changed, 12 deletions(-)
----------------------------------------------------------------------
[21/22] incubator-trafodion git commit: Document changes as a result
of usage testing.
Posted by db...@apache.org.
Document changes as a result of usage testing.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/fc644772
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/fc644772
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/fc644772
Branch: refs/heads/master
Commit: fc6447729ef0e7bd02576f6b3b194edbc6f074e7
Parents: 4392a83
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Wed May 4 22:26:34 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Wed May 4 22:26:34 2016 -0600
----------------------------------------------------------------------
.../src/asciidoc/_chapters/concepts.adoc | 13 ++++----
.../src/asciidoc/_chapters/install.adoc | Bin 13534 -> 13248 bytes
docs/odb_user/src/asciidoc/_chapters/load.adoc | 30 ++++++++++---------
.../src/asciidoc/_chapters/requirements.adoc | 1 +
4 files changed, 24 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/fc644772/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/concepts.adoc b/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
index 5a79855..9167902 100644
--- a/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
@@ -201,15 +201,16 @@ You can list available drivers with `-lsdrv`:
```
~/Devel/odb $ ./odb64luo -lsdrv
-Trafodion - Description=Trafodion ODBC Stand Alone Driver +
+Trafodion - Description=Trafodion ODBC Stand Alone Driver
...
```
You can list locally configured data sources with `-lsdsn`:
```
-~/Devel/odb $ ./odb64luo -lsdsn traf - Trafodion
-VMFELICI \u2013 Vertica +
+~/Devel/odb $ ./odb64luo -lsdsn
+traf - Trafodion
+VMFELICI \u2013 Vertica
...
```
@@ -516,7 +517,7 @@ script (`-f`) will be executed, independently from the others, using a different
Running scripts in parallel.
```
-~/Devel/odb $ ./odb64luo -x "select count(*) from types" -f script1.sql
+~/Devel/odb $ ./odb64luo -x "select count(*) from types" -f script1.sql
```
Uses two _independent_ threads executed in parallel. The first thread will run `select count(*) from types` and the other `script1.sql`.
@@ -532,7 +533,7 @@ of `script1.sql` and three instances of `script2.sql` in parallel using `3 + 5 +
Running eleven commands and scripts in parallel
```
-~/Devel/odb $ ./odb64luo -x 3:"select count(*) from types" -f 5:script1.sql \
+~/Devel/odb $ ./odb64luo -x 3:"select count(*) from types" -f 5:script1.sql \
-f 3:script2.sql -q
[1.0.0]--- 1 row(s) selected in 0.000s (prep 0.000s, exec 0.000s, fetch 0.000s/0.000s)
@@ -558,7 +559,7 @@ You can limit the maximum number of threads with `-T` option.
The following command runs the same 11 commands/scripts limiting the number of threads (*and ODBC connections*) to 4:
```
-~/Devel/odb $ ./odb64luo -x 3:"select count(*) from types" -f 5:script1.sql \
+~/Devel/odb $ ./odb64luo -x 3:"select count(*) from types" -f 5:script1.sql \
-f 3:script2.sql -q -T 4
[1.0.0]--- 1 row(s) selected in 0.000s (prep 0.000s, exec 0.000s, fetch 0.000s/0.000s)
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/fc644772/docs/odb_user/src/asciidoc/_chapters/install.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/install.adoc b/docs/odb_user/src/asciidoc/_chapters/install.adoc
index d505a49..f4ce867 100644
Binary files a/docs/odb_user/src/asciidoc/_chapters/install.adoc and b/docs/odb_user/src/asciidoc/_chapters/install.adoc differ
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/fc644772/docs/odb_user/src/asciidoc/_chapters/load.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/load.adoc b/docs/odb_user/src/asciidoc/_chapters/load.adoc
index 9d2f669..087c0dc 100644
--- a/docs/odb_user/src/asciidoc/_chapters/load.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/load.adoc
@@ -124,7 +124,7 @@ If you add a `+` sign in front of the file-name, odb *appends* to `<file>`inste
- `end`: Commit when all rows (assigned to a given thread) have been inserted. +
- `#rows`: Commit every `#rows` inserted rows. +
- `x#rs`: Commit every `#rs` rowset (see `rows`)
-| `direct` | Adds `/*+ DIRECT */` hint to the insert statement. To be used with Vertica databases in order to store inserted rows *directly* into
+| `direct` | Adds `/\*+ DIRECT */`* hint to the insert statement. To be used with Vertica databases in order to store inserted rows **directly** into
the Read-Only Storage (ROS). See Vertica\u2019s documentation.
| `fieldtrunc=\{0-4}` | Defines how odb manages fields longer than the destination target column: +
+
@@ -399,14 +399,14 @@ In addition: you need to *_convert date format_* and replace all occurrences of
The following map file accomplishes these goals:
-***
-$ cat test/load_map/ml1.map +
-# Map file to load TRAFODION.MFTEST.FRIENDS from friends.dat +
-ID:seq:1 # Inserts into ID column a sequence starting from 1 +
-NAME:4:REPLACE:Lucia:Lucy # Loads field #4 into NAME and replace all occurrences of Lucia with Lucy +
-AGE:2 # Loads field #2 (they start from zero) into AGE +
+```
+$ cat test/load_map/ml1.map
+# Map file to load TRAFODION.MFTEST.FRIENDS from friends.dat
+ID:seq:1 # Inserts into ID column a sequence starting from 1
+NAME:4:REPLACE:Lucia:Lucy # Loads field #4 into NAME and replace all occurrences of Lucia with Lucy
+AGE:2 # Loads field #2 (they start from zero) into AGE
BDATE:6:DCONV:d.b.y # Loads field #6 into BDATE converting date format from dd mmm yyyy
-***
+```
<<<
Load as follows:
@@ -479,7 +479,7 @@ CREATE TABLE TRAFODION.MAURIZIO."PERSON"
, BDATE DATE NOT NULL
, SEX CHAR(1) NOT NULL
, EMAIL VARCHAR(40) NOT NULL
-, SALARY NUMERIC SIGNED(9,2) NOT NULL
+, SALARY NUMERIC(9,2) NOT NULL
, EMPL VARCHAR(40) NOT NULL
, NOTES VARCHAR(80)
, LOADTS TIMESTAMP(0)
@@ -492,13 +492,14 @@ CREATE TABLE TRAFODION.MAURIZIO."PERSON"
You can use a mapfile like this:
```
-~/Devel/odb $ cat person.map PID:SEQ:100
-
+~/Devel/odb $ cat person.map
+PID:SEQ:100
FNAME:DSRAND:datasets/first_names.txt
LNAME:DSRAND:datasets/last_names.txt
COUNTRY:DSRAND:datasets/countries.txt
CITY:DSRAND:datasets/cities.txt
-BDATE:DRAND:1800:2012 SEX:LSTRAND:M,F,U
+BDATE:DRAND:1800:2012
+SEX:LSTRAND:M,F,U
EMAIL:EMRAND:3:12:5:8:com,edu,org,net
SALARY:NRAND:9:2
EMPL:DSRAND:datasets/fortune500.txt
@@ -529,8 +530,9 @@ with length between 20 and 80 characters`
You generate and load test data with a command like this:
```
-$ ./ odb64luo -l src=nofile:tgt=traf.maurizio.person:max=1000000:
-map=person.map:rows=5000:parallel=8:loadcmd=U
+$ bin/odb64luo -u user -p password -d traf -l src=nofile:
+tgt=traf.maurizio.person:max=1000000:
+map=person.map:rows=5000:parallel=8:loadcmd=INSERT
```
Please note `src=nofile\u201d (it means _there is no input file_) and `max=1000000` (generate and load one million rows). The above command
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/fc644772/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc
index 9e6eed8..949d6fa 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc
@@ -97,6 +97,7 @@ Please verify these requirements on each node you will install {project-name} on
| FQDN |
• `/etc/hosts` is set up for fully-qualified node names (FQDN). +
• `/etc/resolv.conf` is configured to use a name server. |
+• `hostname --fqdn` shows the fully-qualified node name, if any. +
• `host -T <FQDN>` (responds if using a DNS server, times out otherwise) +
• Simply ssh among nodes using `ssh <FQDN>`.
| Port Availability | The Linux Kernel Firewall (`iptables`) has either been disabled or <<ip-ports,ports required by {project-name}>> have been opened. |
[18/22] incubator-trafodion git commit: Merge remote-tracking branch
'origin/master' into TRAFODION-1949
Posted by db...@apache.org.
Merge remote-tracking branch 'origin/master' into TRAFODION-1949
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/4bc748d3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/4bc748d3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/4bc748d3
Branch: refs/heads/master
Commit: 4bc748d3aba9ae54d8b43368229c2b92dab0159c
Parents: 21d6d8d 56f3dbe
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Mon May 2 11:18:22 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Mon May 2 11:18:22 2016 -0600
----------------------------------------------------------------------
core/Makefile | 13 +-
core/conn/jdbcT4/.gitignore | 5 +
core/conn/jdbcT4/Makefile | 46 +
core/conn/jdbcT4/pom.xml | 169 +
core/conn/jdbcT4/src/assembly/all.xml | 56 +
.../jdbcT4/src/main/java/T4Messages.properties | 686 ++
.../java/org/trafodion/jdbc/t4/Address.java | 117 +
.../main/java/org/trafodion/jdbc/t4/Bytes.java | 269 +
.../jdbc/t4/CONNECTION_CONTEXT_def.java | 149 +
.../jdbc/t4/CachedPreparedStatement.java | 67 +
.../org/trafodion/jdbc/t4/CancelMessage.java | 49 +
.../java/org/trafodion/jdbc/t4/CancelReply.java | 38 +
.../java/org/trafodion/jdbc/t4/Certificate.java | 112 +
.../main/java/org/trafodion/jdbc/t4/Cipher.java | 201 +
.../org/trafodion/jdbc/t4/CloseMessage.java | 48 +
.../java/org/trafodion/jdbc/t4/CloseReply.java | 48 +
.../java/org/trafodion/jdbc/t4/Compression.java | 149 +
.../org/trafodion/jdbc/t4/ConnectMessage.java | 62 +
.../org/trafodion/jdbc/t4/ConnectReply.java | 148 +
.../java/org/trafodion/jdbc/t4/Descriptor2.java | 85 +
.../trafodion/jdbc/t4/ERROR_DESC_LIST_def.java | 42 +
.../org/trafodion/jdbc/t4/ERROR_DESC_def.java | 65 +
.../jdbc/t4/EndTransactionMessage.java | 49 +
.../trafodion/jdbc/t4/EndTransactionReply.java | 49 +
.../org/trafodion/jdbc/t4/ExecuteMessage.java | 107 +
.../org/trafodion/jdbc/t4/ExecuteReply.java | 127 +
.../org/trafodion/jdbc/t4/FetchMessage.java | 63 +
.../java/org/trafodion/jdbc/t4/FetchReply.java | 63 +
.../org/trafodion/jdbc/t4/GenericMessage.java | 45 +
.../org/trafodion/jdbc/t4/GenericReply.java | 43 +
.../jdbc/t4/GetSQLCatalogsMessage.java | 88 +
.../trafodion/jdbc/t4/GetSQLCatalogsReply.java | 54 +
.../jdbc/t4/HPT4ConnectionPoolDataSource.java | 346 +
.../t4/HPT4ConnectionPoolDataSourceFactory.java | 68 +
.../org/trafodion/jdbc/t4/HPT4DataSource.java | 366 ++
.../jdbc/t4/HPT4DataSourceFactory.java | 62 +
.../java/org/trafodion/jdbc/t4/HPT4Desc.java | 542 ++
.../org/trafodion/jdbc/t4/HPT4Exception.java | 38 +
.../java/org/trafodion/jdbc/t4/HPT4Handle.java | 84 +
.../org/trafodion/jdbc/t4/HPT4Messages.java | 324 +
.../jdbc/t4/HPT4ParameterMetaData.java | 243 +
.../trafodion/jdbc/t4/HPT4PooledConnection.java | 238 +
.../jdbc/t4/HPT4PooledConnectionManager.java | 385 ++
.../jdbc/t4/HPT4ResultSetMetaData.java | 309 +
.../main/java/org/trafodion/jdbc/t4/Header.java | 157 +
.../jdbc/t4/InitializeDialogueMessage.java | 66 +
.../jdbc/t4/InitializeDialogueReply.java | 90 +
.../java/org/trafodion/jdbc/t4/InputOutput.java | 682 ++
.../trafodion/jdbc/t4/InterfaceConnection.java | 1420 +++++
.../trafodion/jdbc/t4/InterfaceResultSet.java | 927 +++
.../trafodion/jdbc/t4/InterfaceStatement.java | 1392 +++++
.../trafodion/jdbc/t4/InterfaceUtilities.java | 235 +
.../main/java/org/trafodion/jdbc/t4/Key.java | 161 +
.../org/trafodion/jdbc/t4/LogicalByteArray.java | 345 +
.../org/trafodion/jdbc/t4/MessageDigest.java | 84 +
.../java/org/trafodion/jdbc/t4/NCSAddress.java | 220 +
.../jdbc/t4/OUT_CONNECTION_CONTEXT_def.java | 97 +
.../java/org/trafodion/jdbc/t4/ObjectArray.java | 86 +
.../org/trafodion/jdbc/t4/PrepareMessage.java | 82 +
.../org/trafodion/jdbc/t4/PrepareReply.java | 103 +
.../jdbc/t4/PreparedStatementManager.java | 242 +
.../trafodion/jdbc/t4/SQLItemDescList_def.java | 46 +
.../trafodion/jdbc/t4/SQLItemDescOld_def.java | 54 +
.../org/trafodion/jdbc/t4/SQLItemDesc_def.java | 70 +
.../org/trafodion/jdbc/t4/SQLValueList_def.java | 64 +
.../org/trafodion/jdbc/t4/SQLValue_def.java | 55 +
.../trafodion/jdbc/t4/SQLWarningOrError.java | 47 +
.../trafodion/jdbc/t4/SQL_DataValue_def.java | 54 +
.../org/trafodion/jdbc/t4/SecClientMsgKeys.java | 58 +
.../main/java/org/trafodion/jdbc/t4/SecPwd.java | 265 +
.../trafodion/jdbc/t4/SecResourceBundle.java | 57 +
.../org/trafodion/jdbc/t4/SecdefsCommon.java | 84 +
.../java/org/trafodion/jdbc/t4/Security.java | 319 +
.../trafodion/jdbc/t4/SecurityException.java | 47 +
.../jdbc/t4/SetConnectionOptionMessage.java | 50 +
.../jdbc/t4/SetConnectionOptionReply.java | 45 +
.../java/org/trafodion/jdbc/t4/SymCrypto.java | 87 +
.../java/org/trafodion/jdbc/t4/T4Address.java | 315 +
.../org/trafodion/jdbc/t4/T4Connection.java | 505 ++
.../org/trafodion/jdbc/t4/T4DSProperties.java | 967 +++
.../trafodion/jdbc/t4/T4DatabaseMetaData.java | 5901 ++++++++++++++++++
.../java/org/trafodion/jdbc/t4/T4Driver.java | 367 ++
.../org/trafodion/jdbc/t4/T4LogFormatter.java | 236 +
.../trafodion/jdbc/t4/T4LoggingUtilities.java | 816 +++
.../org/trafodion/jdbc/t4/T4Properties.java | 2511 ++++++++
.../java/org/trafodion/jdbc/t4/T4ResultSet.java | 164 +
.../java/org/trafodion/jdbc/t4/T4Statement.java | 204 +
.../org/trafodion/jdbc/t4/T4TimerThread.java | 116 +
.../org/trafodion/jdbc/t4/T4_Dcs_Cancel.java | 115 +
.../org/trafodion/jdbc/t4/T4_Dcs_Connect.java | 123 +
.../java/org/trafodion/jdbc/t4/TRANSPORT.java | 263 +
.../jdbc/t4/TerminateDialogueMessage.java | 38 +
.../jdbc/t4/TerminateDialogueReply.java | 39 +
.../jdbc/t4/TrafT4CallableStatement.java | 2462 ++++++++
.../org/trafodion/jdbc/t4/TrafT4Connection.java | 1987 ++++++
.../jdbc/t4/TrafT4PreparedStatement.java | 2558 ++++++++
.../org/trafodion/jdbc/t4/TrafT4ResultSet.java | 5106 +++++++++++++++
.../org/trafodion/jdbc/t4/TrafT4Statement.java | 1690 +++++
.../org/trafodion/jdbc/t4/USER_DESC_def.java | 61 +
.../java/org/trafodion/jdbc/t4/Utility.java | 636 ++
.../org/trafodion/jdbc/t4/VERSION_LIST_def.java | 65 +
.../java/org/trafodion/jdbc/t4/VERSION_def.java | 61 +
.../java/org/trafodion/jdbc/t4/Vproc.java-tmpl | 36 +
.../jdbc/t4/odbc_Dcs_GetObjRefHdl_exc_.java | 95 +
.../jdbc/t4/odbc_Dcs_StopSrvr_exc_.java | 86 +
.../jdbc/t4/odbc_SQLSvc_Close_exc_.java | 69 +
.../t4/odbc_SQLSvc_EndTransaction_exc_.java | 87 +
.../jdbc/t4/odbc_SQLSvc_Execute_exc_.java | 89 +
.../jdbc/t4/odbc_SQLSvc_Fetch_exc_.java | 87 +
.../t4/odbc_SQLSvc_GetSQLCatalogs_exc_.java | 100 +
.../t4/odbc_SQLSvc_InitializeDialogue_exc_.java | 76 +
.../jdbc/t4/odbc_SQLSvc_Prepare_exc_.java | 68 +
.../odbc_SQLSvc_SetConnectionOption_exc_.java | 70 +
.../t4/odbc_SQLSvc_TerminateDialogue_exc_.java | 66 +
.../jdbcT4/src/main/java/secClient.properties | 53 +
.../CallableStatementSample.java | 83 +
.../CallableStatementSample/IntegerSPJ.java | 28 +
.../main/samples/CallableStatementSample/README | 42 +
.../main/samples/DBMetaSample/DBMetaSample.java | 132 +
.../jdbcT4/src/main/samples/DBMetaSample/README | 904 +++
.../PreparedStatementSample.java | 151 +
.../main/samples/PreparedStatementSample/README | 232 +
core/conn/jdbcT4/src/main/samples/README | 47 +
.../src/main/samples/ResultSetSample/README | 91 +
.../ResultSetSample/ResultSetSample.java | 104 +
.../src/main/samples/StatementSample/README | 92 +
.../StatementSample/StatementSample.java | 104 +
.../src/main/samples/common/sampleUtils.java | 268 +
.../jdbcT4/src/main/samples/t4jdbc.properties | 26 +
.../java/org/trafodion/jdbc/t4/AppTest.java | 61 +
.../java/org/trafodion/jdbc/t4/RunAllTests.java | 31 +
.../org/trafodion/jdbc/t4/T4DriverTest.java | 49 +
core/conn/jdbc_type4/.gitignore | 3 -
core/conn/jdbc_type4/build.xml | 142 -
core/conn/jdbc_type4/getBuildInfo | 24 -
.../CallableStatementSample.java | 83 -
.../CallableStatementSample/IntegerSPJ.java | 28 -
.../samples/CallableStatementSample/README | 42 -
.../samples/DBMetaSample/DBMetaSample.java | 132 -
.../conn/jdbc_type4/samples/DBMetaSample/README | 904 ---
.../PreparedStatementSample.java | 151 -
.../samples/PreparedStatementSample/README | 232 -
core/conn/jdbc_type4/samples/README | 47 -
.../jdbc_type4/samples/ResultSetSample/README | 91 -
.../ResultSetSample/ResultSetSample.java | 104 -
.../jdbc_type4/samples/StatementSample/README | 92 -
.../StatementSample/StatementSample.java | 104 -
core/conn/jdbc_type4/samples/build.xml | 44 -
.../jdbc_type4/samples/common/sampleUtils.java | 268 -
core/conn/jdbc_type4/samples/t4jdbc.properties | 26 -
core/conn/jdbc_type4/src/T4Messages.properties | 686 --
.../src/org/trafodion/jdbc/t4/Address.java | 117 -
.../src/org/trafodion/jdbc/t4/Bytes.java | 269 -
.../jdbc/t4/CONNECTION_CONTEXT_def.java | 149 -
.../jdbc/t4/CachedPreparedStatement.java | 67 -
.../org/trafodion/jdbc/t4/CancelMessage.java | 49 -
.../src/org/trafodion/jdbc/t4/CancelReply.java | 38 -
.../src/org/trafodion/jdbc/t4/Certificate.java | 112 -
.../src/org/trafodion/jdbc/t4/Cipher.java | 201 -
.../src/org/trafodion/jdbc/t4/CloseMessage.java | 48 -
.../src/org/trafodion/jdbc/t4/CloseReply.java | 48 -
.../src/org/trafodion/jdbc/t4/Compression.java | 149 -
.../org/trafodion/jdbc/t4/ConnectMessage.java | 62 -
.../src/org/trafodion/jdbc/t4/ConnectReply.java | 148 -
.../src/org/trafodion/jdbc/t4/Descriptor2.java | 85 -
.../trafodion/jdbc/t4/ERROR_DESC_LIST_def.java | 42 -
.../org/trafodion/jdbc/t4/ERROR_DESC_def.java | 65 -
.../jdbc/t4/EndTransactionMessage.java | 49 -
.../trafodion/jdbc/t4/EndTransactionReply.java | 49 -
.../org/trafodion/jdbc/t4/ExecuteMessage.java | 107 -
.../src/org/trafodion/jdbc/t4/ExecuteReply.java | 127 -
.../src/org/trafodion/jdbc/t4/FetchMessage.java | 63 -
.../src/org/trafodion/jdbc/t4/FetchReply.java | 63 -
.../org/trafodion/jdbc/t4/GenericMessage.java | 45 -
.../src/org/trafodion/jdbc/t4/GenericReply.java | 43 -
.../jdbc/t4/GetSQLCatalogsMessage.java | 88 -
.../trafodion/jdbc/t4/GetSQLCatalogsReply.java | 54 -
.../jdbc/t4/HPT4ConnectionPoolDataSource.java | 346 -
.../t4/HPT4ConnectionPoolDataSourceFactory.java | 68 -
.../org/trafodion/jdbc/t4/HPT4DataSource.java | 366 --
.../jdbc/t4/HPT4DataSourceFactory.java | 62 -
.../src/org/trafodion/jdbc/t4/HPT4Desc.java | 542 --
.../org/trafodion/jdbc/t4/HPT4Exception.java | 38 -
.../src/org/trafodion/jdbc/t4/HPT4Handle.java | 84 -
.../src/org/trafodion/jdbc/t4/HPT4Messages.java | 324 -
.../jdbc/t4/HPT4ParameterMetaData.java | 243 -
.../trafodion/jdbc/t4/HPT4PooledConnection.java | 238 -
.../jdbc/t4/HPT4PooledConnectionManager.java | 385 --
.../jdbc/t4/HPT4ResultSetMetaData.java | 309 -
.../src/org/trafodion/jdbc/t4/Header.java | 157 -
.../jdbc/t4/InitializeDialogueMessage.java | 66 -
.../jdbc/t4/InitializeDialogueReply.java | 90 -
.../src/org/trafodion/jdbc/t4/InputOutput.java | 682 --
.../trafodion/jdbc/t4/InterfaceConnection.java | 1420 -----
.../trafodion/jdbc/t4/InterfaceResultSet.java | 927 ---
.../trafodion/jdbc/t4/InterfaceStatement.java | 1392 -----
.../trafodion/jdbc/t4/InterfaceUtilities.java | 235 -
.../src/org/trafodion/jdbc/t4/Key.java | 161 -
.../org/trafodion/jdbc/t4/LogicalByteArray.java | 345 -
.../org/trafodion/jdbc/t4/MessageDigest.java | 84 -
.../src/org/trafodion/jdbc/t4/NCSAddress.java | 220 -
.../jdbc/t4/OUT_CONNECTION_CONTEXT_def.java | 97 -
.../src/org/trafodion/jdbc/t4/ObjectArray.java | 86 -
.../org/trafodion/jdbc/t4/PrepareMessage.java | 82 -
.../src/org/trafodion/jdbc/t4/PrepareReply.java | 103 -
.../jdbc/t4/PreparedStatementManager.java | 242 -
.../trafodion/jdbc/t4/SQLItemDescList_def.java | 46 -
.../trafodion/jdbc/t4/SQLItemDescOld_def.java | 54 -
.../org/trafodion/jdbc/t4/SQLItemDesc_def.java | 70 -
.../org/trafodion/jdbc/t4/SQLValueList_def.java | 64 -
.../src/org/trafodion/jdbc/t4/SQLValue_def.java | 55 -
.../trafodion/jdbc/t4/SQLWarningOrError.java | 47 -
.../trafodion/jdbc/t4/SQL_DataValue_def.java | 54 -
.../org/trafodion/jdbc/t4/SecClientMsgKeys.java | 58 -
.../src/org/trafodion/jdbc/t4/SecPwd.java | 265 -
.../trafodion/jdbc/t4/SecResourceBundle.java | 57 -
.../org/trafodion/jdbc/t4/SecdefsCommon.java | 84 -
.../src/org/trafodion/jdbc/t4/Security.java | 319 -
.../trafodion/jdbc/t4/SecurityException.java | 47 -
.../jdbc/t4/SetConnectionOptionMessage.java | 50 -
.../jdbc/t4/SetConnectionOptionReply.java | 45 -
.../src/org/trafodion/jdbc/t4/SymCrypto.java | 87 -
.../src/org/trafodion/jdbc/t4/T4Address.java | 315 -
.../src/org/trafodion/jdbc/t4/T4Connection.java | 505 --
.../org/trafodion/jdbc/t4/T4DSProperties.java | 967 ---
.../trafodion/jdbc/t4/T4DatabaseMetaData.java | 5901 ------------------
.../src/org/trafodion/jdbc/t4/T4Driver.java | 367 --
.../org/trafodion/jdbc/t4/T4LogFormatter.java | 236 -
.../trafodion/jdbc/t4/T4LoggingUtilities.java | 816 ---
.../src/org/trafodion/jdbc/t4/T4Properties.java | 2511 --------
.../src/org/trafodion/jdbc/t4/T4ResultSet.java | 164 -
.../src/org/trafodion/jdbc/t4/T4Statement.java | 204 -
.../org/trafodion/jdbc/t4/T4TimerThread.java | 116 -
.../org/trafodion/jdbc/t4/T4_Dcs_Cancel.java | 115 -
.../org/trafodion/jdbc/t4/T4_Dcs_Connect.java | 123 -
.../src/org/trafodion/jdbc/t4/TRANSPORT.java | 263 -
.../jdbc/t4/TerminateDialogueMessage.java | 38 -
.../jdbc/t4/TerminateDialogueReply.java | 39 -
.../jdbc/t4/TrafT4CallableStatement.java | 2462 --------
.../org/trafodion/jdbc/t4/TrafT4Connection.java | 1987 ------
.../jdbc/t4/TrafT4PreparedStatement.java | 2558 --------
.../org/trafodion/jdbc/t4/TrafT4ResultSet.java | 5106 ---------------
.../org/trafodion/jdbc/t4/TrafT4Statement.java | 1690 -----
.../org/trafodion/jdbc/t4/USER_DESC_def.java | 61 -
.../src/org/trafodion/jdbc/t4/Utility.java | 636 --
.../org/trafodion/jdbc/t4/VERSION_LIST_def.java | 65 -
.../src/org/trafodion/jdbc/t4/VERSION_def.java | 61 -
.../src/org/trafodion/jdbc/t4/Vproc.java | 36 -
.../jdbc/t4/odbc_Dcs_GetObjRefHdl_exc_.java | 95 -
.../jdbc/t4/odbc_Dcs_StopSrvr_exc_.java | 86 -
.../jdbc/t4/odbc_SQLSvc_Close_exc_.java | 69 -
.../t4/odbc_SQLSvc_EndTransaction_exc_.java | 87 -
.../jdbc/t4/odbc_SQLSvc_Execute_exc_.java | 89 -
.../jdbc/t4/odbc_SQLSvc_Fetch_exc_.java | 87 -
.../t4/odbc_SQLSvc_GetSQLCatalogs_exc_.java | 100 -
.../t4/odbc_SQLSvc_InitializeDialogue_exc_.java | 76 -
.../jdbc/t4/odbc_SQLSvc_Prepare_exc_.java | 68 -
.../odbc_SQLSvc_SetConnectionOption_exc_.java | 70 -
.../t4/odbc_SQLSvc_TerminateDialogue_exc_.java | 66 -
core/conn/jdbc_type4/src/secClient.properties | 53 -
core/conn/jdbc_type4/test/RunAllTests.java | 31 -
.../test/org/trafodion/jdbc/t4/BaseTest.java | 60 -
.../org/trafodion/jdbc/t4/T4DriverTest.java | 47 -
core/conn/trafci/build.xml | 4 +-
core/conn/trafci/install/Installer.java | 2 +-
core/conn/trafci/utils/trafci_install.sh | 2 +-
core/rest/pom.xml | 6 +-
core/sqf/sqenvcom.sh | 3 +-
core/sqf/sql/scripts/install_traf_components | 8 +-
core/sql/exp/ExpLOB.cpp | 33 +-
core/sql/exp/ExpLOB.h | 4 +-
core/sql/exp/ExpLOBinterface.cpp | 4 +-
core/sql/generator/GenItemFunc.cpp | 1 +
core/sql/generator/GenPreCode.cpp | 13 +-
core/sql/lib_mgmt/Makefile | 4 +-
core/sql/optimizer/ImplRule.cpp | 3 +
core/sql/parser/sqlparser.y | 20 +-
core/sql/regress/executor/EXPECTED130 | 82 +-
core/sql/regress/executor/FILTER130 | 9 +-
core/sql/regress/executor/TEST130 | 16 +-
core/sql/regress/udr/EXPECTED002 | 2 +-
core/sql/regress/udr/TEST002 | 2 +-
core/sql/sqlcomp/CmpSeabaseDDLschema.cpp | 43 +-
core/sql/sqlcomp/CmpSeabaseDDLtable.cpp | 3 +-
dcs/pom.xml | 8 +-
.../trafodion/dcs/zookeeper/DcsQuorumPeer.java | 22 +-
.../org/trafodion/dcs/zookeeper/ZKConfig.java | 21 +-
.../trafodion/dcs/zookeeper/ZKServerTool.java | 24 +-
.../org/trafodion/dcs/zookeeper/ZkClient.java | 22 +-
.../org/trafodion/dcs/zookeeper/ZkUtil.java | 23 +-
.../dcs/zookeeper/ZooKeeperMainServerArg.java | 23 +-
dcs/src/test/jdbc_test/jdbc_test.py | 4 +-
tests/phx/phoenix_test.py | 5 +-
293 files changed, 45024 insertions(+), 44995 deletions(-)
----------------------------------------------------------------------
[15/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/_chapters/tables_indexes.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/_chapters/tables_indexes.adoc b/docs/load_transform/src/asciidoc/_chapters/tables_indexes.adoc
index a9f8f78..71de384 100644
--- a/docs/load_transform/src/asciidoc/_chapters/tables_indexes.adoc
+++ b/docs/load_transform/src/asciidoc/_chapters/tables_indexes.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[tables-indexes]]
@@ -31,13 +31,13 @@ The following guidance helps you set up your tables and indexes for better load
[[choose-primary-key]]
== Choose Primary Key
-The primary key for a Trafodion table must be chosen based on the workload that accesses the table.
+The primary key for a {project-name} table must be chosen based on the workload that accesses the table.
-Keyed access to Trafodion tables is very efficient since HBase is a key-value store. You need to analyze the queries
+Keyed access to {project-name} tables is very efficient since HBase is a key-value store. You need to analyze the queries
that are used to access the tables to understand their predicates and join conditions. Once identified, you can
choose a primary key that ensures that the leading key columns have highly selective predicates applied to them.
-This technique limits the number of rows that need to scanned in the HBase. Trafodion uses MDAM (Multi Dimensional Access Method) to limit
+This technique limits the number of rows that need to scanned in the HBase. {project-name} uses MDAM (Multi Dimensional Access Method) to limit
the rows scanned when predicates are present to only trailing key columns and not the leading key column. MDAM works best when the
unique entry count of leading key columns (on which predicates are absent) is low.
@@ -47,7 +47,7 @@ unique entry count of leading key columns (on which predicates are absent) is lo
With range partitioned data in some workloads, certain key ranges of data may see more access than other key ranges. This can lead to an
unbalanced usage pattern with some HBase RegionServers handling most of the load. This behavior is referred to as "hot-spotting."
-With Native HBase tables, hot-spotting is often addressed by designing appropriate keys. In Trafodion, once you choose the key to a table, as
+With Native HBase tables, hot-spotting is often addressed by designing appropriate keys. In {project-name}, once you choose the key to a table, as
discussed in <<choose-primary-key,Choose Primary Key>>, you can use *salting* to distribute the data evenly. Salting applies a
hash function to the salt keys and distributes data to partitions based on this hash value. The hash value is physically stored in the
table as the leading key value. Each split of the table will have only one salt key value.
@@ -61,13 +61,13 @@ cluster and the expected size of the table. A salted table can split if more dat
happens, then more than one partition having rows with the same salt value, which may result in suboptimal execution plans for the table.
<<<
-You can also choose not to salt Trafodion tables. This is similar to range partitioning in a traditional database. The number of partitions
+You can also choose not to salt {project-name} tables. This is similar to range partitioning in a traditional database. The number of partitions
grows with the size of the table, and range boundaries are determined by HBase based on the specified split policy.
[[compression-encoding]]
== Compression and Encoding
-Large Trafodion tables must be encoded and compressed. Trafodion tables that have a large key or several columns grow in size to 10X or more
+Large {project-name} tables must be encoded and compressed. {project-name} tables that have a large key or several columns grow in size to 10X or more
when compared to a Hive table with equivalent data since HBase stores the key separately for every column in a row.
HBase provides several types of encoding to avoid storing the same key value to disk for every column in the row. HBase also supports various
@@ -80,7 +80,7 @@ determine the best compression technique for your tables.
[[create-trafodion-tables-and-indexes]]
== Create Tables and Indexes
-Create Trafodion tables using the CREATE TABLE statements with the `SALT USING <num> PARTITIONS` clause for salting and
+Create {project-name} tables using the CREATE TABLE statements with the `SALT USING <num> PARTITIONS` clause for salting and
the `HBASE_OPTIONS` clause for compression and encoding.
*Example*
@@ -114,10 +114,10 @@ SALT LIKE TABLE;
== Update Statistics
-To generate good plans that allow queries to execute quickly and use resources wisely, the Trafodion Optimizer must have a good idea about how the
-values of columns are distributed, the number of distinct values, and so on. Trafodion supplies this information to the optimizer in the
+To generate good plans that allow queries to execute quickly and use resources wisely, the {project-name} Optimizer must have a good idea about how the
+values of columns are distributed, the number of distinct values, and so on. {project-name} supplies this information to the optimizer in the
form of histograms generated by executing the UPDATE STATISTICS statement. See the
-http://trafodion.apache.org/docs/sql_reference/index.html#update_statistics_statement[Trafodion SQL Reference Manual] for a full
+{docs-url}/sql_reference/index.html#update_statistics_statement[{project-name} SQL Reference Manual] for a full
description of this statement.
=== Default Sampling
@@ -174,7 +174,7 @@ PREPARE s FROM SELECT...;
```
The value of the CQD USTAT_AUTOMATION_INTERVAL is intended to determine the automation interval (in minutes) for update statistics
-automation. The PREPARE statement causes the Trafodion Compiler to compile and optimize a query without executing it. In the process
+automation. The PREPARE statement causes the {project-name} Compiler to compile and optimize a query without executing it. In the process
of doing so with automation enabled, any histograms needed by the optimizer that are missing causes those columns to be marked
as needing histograms. Then, the following UPDATE STATISTICS statement can be run against each table to generate the needed histograms:
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/_chapters/trickle_load.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/_chapters/trickle_load.adoc b/docs/load_transform/src/asciidoc/_chapters/trickle_load.adoc
index 8ab3964..9f2ef91 100644
--- a/docs/load_transform/src/asciidoc/_chapters/trickle_load.adoc
+++ b/docs/load_transform/src/asciidoc/_chapters/trickle_load.adoc
@@ -20,19 +20,19 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[trickle-load]]
= Trickle Load
-Trafodion Trickle Load allows data to be committed in batches, with sizes ranging from 1 row to a several
+{project-name} Trickle Load allows data to be committed in batches, with sizes ranging from 1 row to a several
thousand rows in each commit. Trickle Load uses the following SQL statements (defined in the
-http://trafodion.incubator.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual]:
+{docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual]:
-* http://trafodion.incubator.apache.org/docs/sql_reference/index.html#insert_statement[INSERT]
-* http://trafodion.apache.org/docs/sql_reference/index.html#upsert_statement[UPSERT]
-* http://trafodion.apache.org/docs/sql_reference/index.html#upsert_statement[UPSERT USING LOAD]
+* {docs-url}/sql_reference/index.html#insert_statement[INSERT]
+* {docs-url}/sql_reference/index.html#upsert_statement[UPSERT]
+* {docs-url}/sql_reference/index.html#upsert_statement[UPSERT USING LOAD]
Contrary to <<bulk-load,Bulk Load>>, committed rows are immediately visible from other transactions
thereby leading to minimal latency in making newly ingested rows visible to applications and end users.
@@ -44,12 +44,12 @@ application for this approach.
* You want to migrate a smaller amount of data (a few millions rows). Typically, you use JDBC- or
ODBC-based ETL tools for this approach; for example:
-** <<trickle-load-odb,Trafodion odb^1^>>
+** <<trickle-load-odb,{project-name} odb^1^>>
** http://squirrel-sql.sourceforge.net[SQuirrel-SQL]
** http://www.pentaho.com/[Pentaho]
** http://www.informatica.com/us/[Informatica].
-^1^ Trafodion obd typically achieves better load throughput than third-party ETL tools.
+^1^ {project-name} obd typically achieves better load throughput than third-party ETL tools.
[[trickle-load-improving-throughput]]
== Improving Throughput
@@ -76,7 +76,7 @@ the `hbase shell` through an `ALTER 'TRAFODION.<schema-name>.<table-name>', MEMS
[[trickle-load-odb]]
== odb
-odb is a Linux and Windows Trafodion client that is:
+odb is a Linux and Windows {project-name} client that is:
* ODBC based
* Database agnostic query driver
@@ -85,7 +85,7 @@ odb is a Linux and Windows Trafodion client that is:
odb may be installed on:
-* The Trafodion cluster.
+* The {project-name} cluster.
* The machine that contains source data
* An intermediate machine that is being used for data loading.
@@ -96,7 +96,7 @@ odd uses threads to achieve parallelism, rowsets to improve throughput. You can
insert types.
NOTE: odb does not use the bulk load command LOAD, and, therefore, throughput when using odb may be lower than what can be achieved
-with the bulk loader. However, when using the odb tool, source data need not be moved to the Trafodion cluster in a separate step.
+with the bulk loader. However, when using the odb tool, source data need not be moved to the {project-name} cluster in a separate step.
odb allows you to access Hadoop data using one of the following methods:
@@ -114,7 +114,7 @@ The following odb commands/features are discussed in this guide:
* <<trickle-load-odb-extract, odb Extract>>
* <<trickle-load-odb-transform, odb Transform>>
-See the http://trafodion.incubator.apache.org/docs/odb/index.html[Trafodion odb User Guide]
+See the {docs-url}/odb/index.html[{project-name} odb User Guide]
for installation instructions and usage syntax for the odb tool.
The following subsections assume that you've installed odb.
@@ -131,7 +131,7 @@ The default insert type used by odb is INSERT; to use UPSERT USING LOAD, please
Copy the table `mytable` from `<source_catalog>.<source_schema>` on the source database to `trafodion.my
schema.mytable`
-on Trafodion.
+on {project-name}.
```
odb64luo -u <src_username>:<tgt_username> -p <src_pswd>:<tgt_pswd>
@@ -146,19 +146,19 @@ odb64luo -u <src_username>:<tgt_username> -p <src_pswd>:<tgt_pswd>
| `src_username` | User name for the source database.
| `src_pswd` | Password for the source database.
| `src_dsn` | ODBC DSN for the source database.
-| `tgt_username` | User name for the Trafodion database.
-| `tgt_pswd` | Password for the Trafodion database.
-| `tgt_dsn` | ODBC DSN for the Trafodion database.
+| `tgt_username` | User name for the {project-name} database.
+| `tgt_pswd` | Password for the {project-name} database.
+| `tgt_dsn` | ODBC DSN for the {project-name} database.
| `splitby` | Defines the column used to evenly distributed values for parallelism. Consider using a leading key column.
-| `parallel=4` | Use four connections to extract data from the source database and another four connections to write data to the target Trafodion database.
+| `parallel=4` | Use four connections to extract data from the source database and another four connections to write data to the target {project-name} database.
| `loadcmd=UL` | Use UPSERT USING LOAD syntax to write data.
|===
[[trickle-load-odb-load]]
=== odb Load
-Refer to the http://trafodion.apache.org/docs/odb/index.html#_load_files[Load Files] section
-in the http://trafodion.apache.org/docs/odb/index.html[Trafodion odb User Guide] for complete
+Refer to the {docs-url}/odb/index.html#_load_files[Load Files] section
+in the {docs-url}/odb/index.html[{project-name} odb User Guide] for complete
documentation of this option.
You use the `-l` option to load into a table from:
@@ -237,10 +237,10 @@ odb64luo -u user -p xx -d dsn -T 5 \
=== odb Copy
Refer to the
-http://trafodion.apache.org/docs/odb/index.html#_copy_tables_from_one_database_to_another[Copy Tables From One Database to Another]
-section in the http://trafodion.apache.org/docs/odb/index.html[Trafodion odb User Guide] for complete documentation of this option.
+{docs-url}/odb/index.html#_copy_tables_from_one_database_to_another[Copy Tables From One Database to Another]
+section in the {docs-url}/odb/index.html[{project-name} odb User Guide] for complete documentation of this option.
-Use the `-cp` option to copy tables *directly* from one data-source to another using ODBC (for example, from Trafodion to Teradata
+Use the `-cp` option to copy tables *directly* from one data-source to another using ODBC (for example, from {project-name} to Teradata
or vice-versa):
* Single/Multiple table(s) copy from one database to another
@@ -324,8 +324,8 @@ src=TRAFODION.MAURIZIO.LINEITEM:splitby=L_PARTKEY
[[trickle-load-odb-extract]]
=== odb Extract
-Refer to the http://trafodion.apache.org/docs/odb/index.html#_extract_tables[Extract Tables]
-section in the http://trafodion.apache.org/docs/odb/index.html[Trafodion odb User Guide] for complete documentation of this option.
+Refer to the {docs-url}/odb/index.html#_extract_tables[Extract Tables]
+section in the {docs-url}/odb/index.html[{project-name} odb User Guide] for complete documentation of this option.
Use then -e option to extract from data a table and write it to standard files or named pipes.
@@ -412,8 +412,8 @@ appending extraction data and time (`_%d%m`) for the target file name.
[[trickle-load-odb-transform]]
=== odb Transform
-Refer to the http://trafodion.apache.org/docs/odb/index.html#load_map_fields[Map Source File Fields to Target Table Columns]
-section in the http://trafodion.apache.org/docs/odb/index.html[Trafodion odb User Guide] for complete documentation of
+Refer to the {docs-url}/odb/index.html#load_map_fields[Map Source File Fields to Target Table Columns]
+section in the {docs-url}/odb/index.html[{project-name} odb User Guide] for complete documentation of
odb's mapping/transformation capabilities.
odb provides mapping/transformation capabilities though mapfiles. By specifying `map=<mapfile>` load option you can:
@@ -491,6 +491,6 @@ $ odb64luo -u user -p xx -d dsn \
The above example:
* Reads data from `friends.dat` (`src`).
-* Writes data to the `TRAFODION.MFTEST.FRIENDS` Trafodion table (`tgt`).
+* Writes data to the `TRAFODION.MFTEST.FRIENDS` {project-name} table (`tgt`).
* Uses `ml1.map` to define transformation specifications (`map`).
* Uses comma as a field separator (`fs`).
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/_chapters/troubleshoot.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/_chapters/troubleshoot.adoc b/docs/load_transform/src/asciidoc/_chapters/troubleshoot.adoc
index 77624ec..1d8f446 100644
--- a/docs/load_transform/src/asciidoc/_chapters/troubleshoot.adoc
+++ b/docs/load_transform/src/asciidoc/_chapters/troubleshoot.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[troubleshoot]]
@@ -56,7 +56,7 @@ SELECT MAX(LENGTH(<col-name>)) FROM <hive-tab-name>;
If the query returns a value less than the current HIVE_MAX_STRING_LENGTH, then you need to
increase that value and retry. If the query returns a value that is far less than the current
HIVE_MAX_STRING_LENGTH, then you can achieve better performance by reducing the value.
-An approximate value can be used, too. The Trafodion default of 32000 may be too generous in some cases.
+An approximate value can be used, too. The {project-name} default of 32000 may be too generous in some cases.
== Checking Plan Quality
@@ -64,7 +64,7 @@ It is good practice to check the quality of the plan generated by the SQL compil
data loading statement that may take a long time to complete.
* For INSERT and UPSERT USING LOAD statements, use the EXPLAIN statement, which is described in the
-http://trafodion.apache.org/docs/sql_reference/index.html#explain_statement[Trafodion SQL Reference Manual].
+{docs-url}/sql_reference/index.html#explain_statement[{project-name} SQL Reference Manual].
* For the LOAD statement, which is implemented as a utility operator (that is, a collection of secondary SQL statements),
use the following SQL statements to see the plan that it uses to add data to the target table:
@@ -74,8 +74,8 @@ PREPARE s1 FROM LOAD TRANSFORM INTO <target-table> <select-query-used-as-source>
EXPLAIN OPTIONS 'f' s1 ;
```
-A typical problem with the plan is that the scan is not parallel enough. For Trafodion tables, you can address this
-issue with the default attribute, PARALLEL_NUM_ESPS. Using this attribute, a Trafodion scan can be parallelized to
+A typical problem with the plan is that the scan is not parallel enough. For {project-name} tables, you can address this
+issue with the default attribute, PARALLEL_NUM_ESPS. Using this attribute, a {project-name} scan can be parallelized to
as many number of SALT partitions that are defined for the table. For Hive source tables, the default attributes,
HIVE_NUM_ESPS_PER_DATANODE and HIVE_MIN_BYTES_PER_ESP_PARTITION, can be used to adjust the degree of parallelism.
@@ -106,12 +106,12 @@ UPDATE STATISTICS FOR TABLE t ON EVERY COLUMN SAMPLE RANDOM 1 PERCENT;
== Index Creation Takes Too Long
-When creating an index, all rows of the Trafodion table must be scanned and a subset of columns is returned to the client.
-This can take a while to complete. If there is a Hive table with the same data as the Trafodion table being scanned, then
+When creating an index, all rows of the {project-name} table must be scanned and a subset of columns is returned to the client.
+This can take a while to complete. If there is a Hive table with the same data as the {project-name} table being scanned, then
you can specify the default attribute, USE_HIVE_SOURCE. This causes the Hive table to be used as the source creating the index.
-NOTE: The name of the Hive table must use the Trafodion table name as its prefix.
-For example, if the Trafodion table is TRAFODION.SCH.DEMO, then the Hive
+NOTE: The name of the Hive table must use the {project-name} table name as its prefix.
+For example, if the {project-name} table is TRAFODION.SCH.DEMO, then the Hive
table name can be DEMO_SRC. In this case, set the attribute as follows: +
+
```
@@ -131,7 +131,7 @@ or update should be broken up into multiple statements each affecting less than
== Large UPSERT USING LOAD On a Table With Index Errors Out
-UPSERT USING LOAD automatically reverts to a transactional UPSERT when used on a table with an index. This causes Trafodion
+UPSERT USING LOAD automatically reverts to a transactional UPSERT when used on a table with an index. This causes {project-name}
to run into the limitation discusses in <<large-deletes,Large Deletes Take Too Long or Error Out>> above:
no more than 10,000*n rows (n = number of nodes) can be affected in a single statement.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/index.adoc b/docs/load_transform/src/asciidoc/index.adoc
index 7f41e22..16118f7 100644
--- a/docs/load_transform/src/asciidoc/index.adoc
+++ b/docs/load_transform/src/asciidoc/index.adoc
@@ -32,7 +32,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
:images: ../images
:leveloffset: 1
@@ -41,22 +42,13 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-**License Statement**
+include::../../shared/license.txt[]
+<<<
-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
+include::../../shared/acknowledgements.txt[]
-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.
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/pom.xml
----------------------------------------------------------------------
diff --git a/docs/messages_guide/pom.xml b/docs/messages_guide/pom.xml
index e3d3e27..31d4c52 100644
--- a/docs/messages_guide/pom.xml
+++ b/docs/messages_guide/pom.xml
@@ -183,6 +183,10 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -201,6 +205,10 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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
index fe6c999..586b010 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/about.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/about.adoc
@@ -20,19 +20,19 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
-Trafodion is a relational database management system based on
+{project-name} 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
+produced by the {project-name} 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
+This manual was written for {project-name} database administrators and
+programmers who use the {project-name} database software conversational or
programmatic interface.
== New and Changed Information
@@ -166,19 +166,8 @@ 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:
-
-issues@trafodion.incubator.apache.org
+We encourage 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 {project-support}.
Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
-Or, even better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/binder_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/binder_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/binder_msgs.adoc
index bd3122d..20c9d5b 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/binder_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/binder_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[binder-and-compilation-messages]]
@@ -36,7 +36,7 @@
Column <name-1> is not found. Tables in scope: <name-2>. Default schema: <name-3>.
```
-*Cause:* You referenced column <name-1>, which the Trafodion database
+*Cause:* You referenced column <name-1>, which the {project-name} database
software could not find. The table <name-2> or tables in the scope of the
column reference and the default schema <name-3> appear.
@@ -76,7 +76,7 @@ found, and resubmit.
Column <name-1> is not found. Table <name-2> not exposed. Tables in scope: <name-3>. Default schema: <name-4>.
```
-*Cause:* You referenced column <name-1>, which the Trafodion database
+*Cause:* You referenced column <name-1>, which the {project-name} database
software could not find. Table <name-2> is not exposed. The table <name-3>
or tables in the scope of the column reference and the default schema
<name-4> appear.
@@ -211,7 +211,7 @@ Reference made to column <name> via star (*) is ambiguous.
Where <name> is the name of the column.
*Cause:* You referred to column <name> using the `SELECT *` or `SELECT TBL.*`
-reference, and the Trafodion database software could not locate the column
+reference, and the {project-name} database software could not locate the column
because the reference is ambiguous.
*Effect:* The operation fails.
@@ -425,7 +425,7 @@ Error while preparing constraint <name> on table <table-name>.
Where <table-name> is the name of the table.
-*Cause:* Trafodion received an error while
+*Cause:* {project-name} received an error while
preparing constraint <name> on <table-name>. See accompanying error
messages.
@@ -912,7 +912,7 @@ partition, which is not supported.
The preceding error actually occurred in function <name>.
```
-*Cause:* Trafodion detected an error in function
+*Cause:* {project-name} detected an error in function
<name>. Errors that appear before this one refer to the low level
computations that this function uses.
@@ -1234,7 +1234,7 @@ which is not supported.
The number of output dynamic parameters (<value-1>) must equal the number of selected values (<value-2>).
```
-*Cause:* Trafodion requires that the number of
+*Cause:* {project-name} requires that the number of
output dynamic parameters, <value-1), match the number of selected
values, <value-2>.
@@ -1250,7 +1250,7 @@ The number of output host variables (<value-1>) must equal the
number of selected values (<value-2>).
```
-*Cause:* Trafodion requires that the number of
+*Cause:* {project-name} requires that the number of
output host variables, <value-1>, match the number of selected values,
<value-2>.
@@ -1352,7 +1352,7 @@ clause, the preceding join search condition must be enclosed in
parentheses.
```
-*Cause:* A syntax error has caused the Trafodion database software to
+*Cause:* A syntax error has caused the {project-name} database software to
treat object <name> as an ambiguous entity.
*Effect:* The operation fails.
@@ -1382,7 +1382,7 @@ other than an outermost SELECT statement.
```
If a character literal was intended, you must use the single quote
-delimiter: <literal>. The use of double quotes causes Trafodion to
+delimiter: <literal>. The use of double quotes causes {project-name} to
interpret <column-name> as a delimited identifier column name.
```
@@ -1414,10 +1414,10 @@ single quote delimiter instead of the double: 'Lower' instead of
Translation name is not recognized.
```
-*Cause:* Trafodion does not recognize the
+*Cause:* {project-name} does not recognize the
translation name.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Use one of the supported translation names.
@@ -1577,7 +1577,7 @@ Absolute and relative sampling cannot occur in the same BALANCE expression.
*Cause:* You attempted to perform absolute and relative sampling in the
same balance expression, which is not supported.
-*Effect:* Trafodion is unable to prepare the
+*Effect:* {project-name} is unable to prepare the
query.
*Recovery:* Correct the syntax and resubmit.
@@ -1592,7 +1592,7 @@ The sample size for <type> Sampling must be <size-type>.
*Cause:* You specified an invalid combination of sample <type> and
sample <size-type>.
-*Effect:* Trafodion is unable to prepare the
+*Effect:* {project-name} is unable to prepare the
query.
*Recovery:* Correct the syntax and resubmit.
@@ -1607,7 +1607,7 @@ An absolute sample size must have a scale of zero.
*Cause:* You specified an absolute sample size with a scale greater than
zero, which is not supported.
-*Effect:* Trafodion is unable to prepare the
+*Effect:* {project-name} is unable to prepare the
query.
*Recovery:* Correct the syntax and resubmit.
@@ -1622,7 +1622,7 @@ The sample size must be less than or equal to the sample period.
*Cause:* You specified a sample size that is greater than the sample
period. It must be less than or equal to the sample period.
-*Effect:* Trafodion is unable to prepare the
+*Effect:* {project-name} is unable to prepare the
query.
*Recovery:* Correct the syntax and resubmit.
@@ -1690,7 +1690,7 @@ join query is not updatable.
*Effect:* The operation fails.
*Recovery:* An updatable cursor query should not specify a join or a
-nonupdatable query. A Trafodion database software statement cursor is
+nonupdatable query. A {project-name} database software statement cursor is
updatable if all the following are true:
* It is a SELECT statement.
@@ -1792,7 +1792,7 @@ More than one table will be locked: <name>.
Where <name> is the name of the table.
-*Cause:* Trafodion is preparing to lock more than
+*Cause:* {project-name} is preparing to lock more than
one table.
*Effect:* None.
@@ -1853,7 +1853,7 @@ Default volume and subvolume information could not be retrieved from=_DEFAULTS d
Where <number> is the error message.
-*Cause:* Trafodion was not able to retrieve
+*Cause:* {project-name} was not able to retrieve
default volume and subvolume information using the =_DEFAULTS define.
*Effect:* The operation fails.
@@ -1911,7 +1911,7 @@ CHARACTER.
The operation (<name>) is not allowed. Try UNION ALL instead.
```
-*Cause:* You attempted to perform an operation that the Trafodion
+*Cause:* You attempted to perform an operation that the {project-name}
database software does not allow.
*Effect:* The operation fails.
@@ -1965,7 +1965,7 @@ the second expression for your join. You must use the primary key to
prevent returning multiple rows being returned for a single deleted or
updated row.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the WHERE clause to use the primary key of the table
@@ -1981,7 +1981,7 @@ Stream access is supported only on updatable views. View: <table-name>.
*Cause:* You attempted to access a nonupdatable view using stream access
mode.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -1995,7 +1995,7 @@ Table <name> cannot be both read and updated.
*Cause:* You attempted to read from and update the same table.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2011,7 +2011,7 @@ Statement may not compile due to an order requirement on stream expression.
on columns that do not define the prefix of the clustering key of the
base table or of a secondary index.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Create a secondary index whose clustering key materializes
@@ -2029,7 +2029,7 @@ Statement may not compile due to an order requirement on embedded
expression using an ORDER BY without using a clustering key or a
secondary index.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Create a secondary index materializing the order and
@@ -2059,7 +2059,7 @@ Inner relation of left join cannot be stream expression. Tables in scope: <name>
*Cause:* You attempted to perform a left join using the result set of a
stream expression as the inner relation.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2073,7 +2073,7 @@ Join of stream expressions is not supported. Tables in scope: <name>.
*Cause:* You attempted to perform a join of stream expressions.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2087,7 +2087,7 @@ Intersection of stream expressions is not supported. Tables in scope: <name>.
*Cause:* You attempted to perform an intersection of stream expressions.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2103,7 +2103,7 @@ Intersection between embedded <name-1> expression and embedded
*Cause:* You attempted to perform an intersection between two embedded
expressions.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2119,7 +2119,7 @@ expression not supported. Tables in scope: <name-3>, <name-4>.
*Cause:* You attempted to perform a union between two embedded
expressions.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2134,7 +2134,7 @@ GROUP BY is not supported for stream expression. Tables in scope: <name>.
*Cause:* You attempted to perform a GROUP BY in conjunction with a
stream expression.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2150,7 +2150,7 @@ scope: <name-2>.
*Cause:* You attempted to perform a GROUP BY in conjunction with an
embedded expression.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2166,7 +2166,7 @@ Tables in scope: <name>.
*Cause:* You attempted to perform a right join using an embedded
expression as the outer relation.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2182,7 +2182,7 @@ scope: <name>.
*Cause:* You attempted to perform a right join using a stream expression
as the outer relation.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2198,7 +2198,7 @@ scope: <name-1>, <name-2>.
*Cause:* You attempted to use an ORDER BY clause in the UNION of two
streams.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2213,7 +2213,7 @@ Embedded <name> statements are not supported in subqueries.
*Cause:* You attempted to perform a subquery that included an embedded
statement.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2228,7 +2228,7 @@ Stream expressions are not supported in subqueries.
*Cause:* You attempted to perform a subquery that included a stream
expression.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2244,7 +2244,7 @@ FOR UPDATE clause.
*Cause:* You attempted to perform a DECLARE... FOR UPDATE clause that
included an embedded DELETE statement.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2259,7 +2259,7 @@ Stream expressions are not supported for insert statements.
*Cause:* You attempted to perform an insert statement that includes a
stream expression.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2274,7 +2274,7 @@ Embedded <name> statements are not supported in INSERT statements.
*Cause:* You attempted to perform an INSERT that included an embedded
statement.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2289,7 +2289,7 @@ Stream expression is not supported for top level UPDATE statements.
*Cause:* You attempted to perform a top-level UPDATE statement that
included a stream expression.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2301,10 +2301,10 @@ statement.
JOIN_ORDER_BY_USER prevented compiler from reordering query tree.
```
-*Cause:* Trafodion compiler could not reorder the
+*Cause:* {project-name} compiler could not reorder the
join tree because the JOIN_ORDER_BY_USER directive is in effect.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Disable the JOIN_ORDER_BY_USER directive and resubmit.
@@ -2319,7 +2319,7 @@ Join between embedded <name-1> expression and embedded <name-2> expression is no
*Cause:* You attempted to perform a join between two embedded
expressions.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2335,7 +2335,7 @@ not supported. Tables in scope: <name-2>.
*Cause:* You attempted to perform a join between a stream expression and
an embedded expression.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2350,7 +2350,7 @@ Update of <name-1> column <name-2> is not permitted on rollback.
*Cause:* You attempted to update clustering key components or columns
associated with referential integrity constraints during a rollback.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2365,7 +2365,7 @@ Update of variable length column <name> is not permitted on rollback.
*Cause:* You attempted to perform a rollback that included an update of
a variable length column.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2379,7 +2379,7 @@ SEQUENCE BY is not supported for stream expressions.
*Cause:* You included a SEQUENCE BY statement in a stream expression.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2394,7 +2394,7 @@ Stream expression is not supported for top level DELETE statement.
*Cause:* You attempted to use a stream expression to perform a top-level
DELETE.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2454,7 +2454,7 @@ Stream expressions are not supported for compound statements.
*Cause:* You attempted to use a stream expression for a compound
statement.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2469,7 +2469,7 @@ Embedded <name> expression is not supported for compound statements.
*Cause:* You attempted to use an embedded expression for a compound
statement.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2484,7 +2484,7 @@ SEQUENCE BY is not supported for embedded <name> expressions.
*Cause:* You attempted to perform an embedded expression that included
SEQUENCE BY.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2509,7 +2509,7 @@ error, depending on how you have set this attribute value.
on a non-audited table and IUD_NONAUDITED_INDEX_MAINT is set to OFF. This
message is displayed as an error.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2518,7 +2518,7 @@ statement.
on a non-audited table and IUD_NONAUDITED_INDEX_MAINT is set to WARN.
This message appears as an warning.
-*Effect:* Trafodion performs the INSERT, UPDATE,
+*Effect:* {project-name} performs the INSERT, UPDATE,
or DELETE operation. If the operation encounters an error, you will see
other messages about that condition.
@@ -2534,7 +2534,7 @@ Stream access is supported for only key-sequenced tables. Table: <name>.
*Cause:* You attempted to use stream access on a table that is not
key-sequenced, which is required.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2549,7 +2549,7 @@ Embedded <name-1> is supported for only key-sequenced tables. Table: <name-2>.
*Cause:* You attempted to perform an embedded action that is supported
only for key-sequenced tables.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2564,7 +2564,7 @@ Embedded <name> is supported only for updatable views. View: <name-2>.
*Cause:* You attempted to perform an embedded action that is supported
only for updatable views.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2580,7 +2580,7 @@ cover all output values of stream.
*Cause:* You attempted to use an index for stream access that does not
cover all output columns of the base table.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Restrict the select list or add the missing columns to the
@@ -2597,7 +2597,7 @@ cover all columns referenced in WHERE clause of stream.
*Cause:* You attempted to use an index for stream access that does not
cover all base table columns referenced in the WHERE clause.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Add the missing columns to the index.
@@ -2612,7 +2612,7 @@ Update of nullable column <name> is not permitted on rollback.
*Cause:* You attempted to perform a rollback that included an update of
a nullable column.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2627,7 +2627,7 @@ Embedded update/delete statements not supported within an IF statement.
*Cause:* You attempted to embed UPDATE/DELETE statements within an IF
statement.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2643,7 +2643,7 @@ stream because it is partitioned.
*Cause:* You specified <table-name>, a partitioned table, as the order
requirement on a stream.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2658,7 +2658,7 @@ Use of row sets in a predicate with embedded update/delete is not supported.
*Cause:* You attempted to use a row set as a predicate with an embedded
update or embedded delete.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
statement.
*Recovery:* Modify the statement and resubmit.
@@ -2710,12 +2710,12 @@ The FIRST/ANY n syntax cannot be used with an embedded update or embedded delete
Procedure <procedure-name> expects <value-1> parameters but was called with <value-2> parameters.
```
-*Cause:* In the Trafodion database software statement being compiled, a
+*Cause:* In the {project-name} database software statement being compiled, a
stored procedure invocation contains an incorrect number of parameters.
-*Effect:* Trafodion statement is not compiled.
+*Effect:* {project-name} statement is not compiled.
-*Recovery:* Correct the Trafodion database software statement and retry
+*Recovery:* Correct the {project-name} database software statement and retry
the compilation.
[[SQL-4303]]
@@ -2725,11 +2725,11 @@ the compilation.
The supplied type for parameter <value> of routine <routine-name> was <type-name-1> which is not compatible with the expected type <type-name-2>.
```
-*Cause:* In the Trafodion database software statement being compiled,
+*Cause:* In the {project-name} database software statement being compiled,
you attempted to invoke a stored procedure with a type of parameter that
is incompatible with the formal type of the parameter.
-*Effect:* Trafodion statement is not compiled.
+*Effect:* {project-name} statement is not compiled.
*Recovery:* Supply the correct parameter and type and retry the
compilation.
@@ -2741,7 +2741,7 @@ compilation.
Host variable or dynamic parameter <parameter-name> is used in more than one OUT or INOUT parameter for routine <routine-name>. Results may be unpredictable.
```
-*Cause:* In the Trafodion database software statement being compiled,
+*Cause:* In the {project-name} database software statement being compiled,
you attempted to invoke a stored procedure that contains the same host
variable or dynamic parameter in more than one OUT or INOUT parameter.
@@ -2759,13 +2759,13 @@ Parameter <value> for user-defined routine <routine-name> is an OUT
or INOUT parameter and must be a host variable or a dynamic parameter.
```
-*Cause:* In the Trafodion database software statement being compiled,
+*Cause:* In the {project-name} database software statement being compiled,
you attempted to invoke a stored procedure that has an OUT or INOUT
parameter that is neither a host variable nor a dynamic parameter.
-*Effect:* Trafodion statement is not compiled.
+*Effect:* {project-name} statement is not compiled.
-*Recovery:* Correct the Trafodion database software statement. Supply a
+*Recovery:* Correct the {project-name} database software statement. Supply a
host variable or a dynamic parameter for OUT or INOUT parameters, and
retry the compilation.
@@ -2776,10 +2776,10 @@ retry the compilation.
A CALL statement is not allowed within a compound statement.
```
-*Cause:* In the Trafodion database software statement being compiled, a
+*Cause:* In the {project-name} database software statement being compiled, a
CALL statement was present within a BEGIN...END block.
-*Effect:* Trafodion statement is not compiled.
+*Effect:* {project-name} statement is not compiled.
*Recovery:* Remove the CALL statement from the compound statement and
retry the compilation.
@@ -2791,11 +2791,11 @@ retry the compilation.
Rowset parameters are not allowed in a CALL statement.
```
-*Cause:* In the Trafodion database software statement being compiled,
+*Cause:* In the {project-name} database software statement being compiled,
you attempted to use a row set as a parameter in a stored procedure
invocation.
-*Effect:* Trafodion statement is not compiled.
+*Effect:* {project-name} statement is not compiled.
*Recovery:* Alter the data type of the relevant variable, or use a
different non-row-set host variable. Retry the compilation.
@@ -2808,11 +2808,11 @@ Internal error: Unsupported SQL data type <value> specified for a
CALL statement parameter.
```
-*Cause:* In the Trafodion database software statement being compiled, a
+*Cause:* In the {project-name} database software statement being compiled, a
parameter in a stored procedure invocation had an unsupported SQL data
type.
-*Effect:* Trafodion statement is not compiled.
+*Effect:* {project-name} statement is not compiled.
*Recovery:* This error should never occur. Drop the stored procedure and
re-create it with an appropriate data type. Report this problem to HP
@@ -2828,15 +2828,15 @@ stored procedure result sets are not yet supported.
Where <procedure-name> is the ANSI name of a stored procedure.
-*Cause:* You are running a Trafodion database software version that does
+*Cause:* You are running a {project-name} database software version that does
not support stored procedure result sets and attempted to compile a CALL
statement for a stored procedure that returns result sets. This message
indicates a downgrade has been performed without removing stored
procedures that return result sets.
-*Effect:* Trafodion statement is not compiled.
+*Effect:* {project-name} statement is not compiled.
-*Recovery:* Migrate to a Trafodion database software version that
+*Recovery:* Migrate to a {project-name} database software version that
supports stored procedure result sets.
[[SQL-4310]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/compiler_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/compiler_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/compiler_msgs.adoc
index e5abe09..b062199 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/compiler_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/compiler_msgs.adoc
@@ -20,11 +20,11 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[trafodion-compiler-messages]]
-= Trafodion Compiler Messages (2000 through 2999)
+= {project-name} Compiler Messages (2000 through 2999)
This section includes process creation errors, IPC errors, static compilation errors, and miscellaneous errors from the optimizer.
@@ -35,11 +35,11 @@ This section includes process creation errors, IPC errors, static compilation er
Internal error: error from MXCMP; cannot work on this query.
```
-*Cause:* Trafodion received an internal error from the Trafodion compiler.
+*Cause:* {project-name} received an internal error from the {project-name} compiler.
*Effect:* The operation fails.
-*Recovery:* None. Report the entire message to mailto:user@trafodion.incubator.apache.org[the Trafodion User mailing list].
+*Recovery:* None. Report the entire message to {project-support}.
[[SQL-2009]]
== SQL 2009
@@ -48,7 +48,7 @@ Internal error: error from MXCMP; cannot work on this query.
The user transaction must be rolled back (or committed, if that makes sense in the application) before MXCMP can be restarted and proceed.
```
-*Cause:* An outstanding transaction must be resolved before the Trafodion compiler can be restarted.
+*Cause:* An outstanding transaction must be resolved before the {project-name} compiler can be restarted.
*Effect:* The operation fails.
@@ -66,7 +66,7 @@ Where error <number> is the error number.
Where <name> is the name of the program file.
-*Cause:* Trafodion was unable to create a server
+*Cause:* {project-name} was unable to create a server
process because of the process control procedure error <number> it
received while resolving the program file name.
@@ -90,7 +90,7 @@ Where <number-2> is the TPCError.
Where <text> is the error message text.
-*Cause:* Trafodion was unable to create server
+*Cause:* {project-name} was unable to create server
process <name> because of the process control procedure error <number>
it received. More information appears in detail <text>.
@@ -110,7 +110,7 @@ Where <name> is the name of the server process.
Where <number> is the error number.
-*Cause:* Trafodion was unable to create server
+*Cause:* {project-name} was unable to create server
process <name> because of the process control procedure error <number>
it received on the program file.
@@ -129,11 +129,11 @@ Where <name> is the server process name.
Where <number> is the error number.
-*Cause:* Trafodion was unable to create server
+*Cause:* {project-name} was unable to create server
process <name> because of the process control procedure error <number>
it received on the swap file.
-*Effect:* Trafodion does not create the server process.
+*Effect:* {project-name} does not create the server process.
*Recovery:* Use the process control procedure error to diagnose and correct the problem.
@@ -147,7 +147,7 @@ Server process <name> could not be created - unlicensed privileged program.
Where <name> is the server process name.
-*Cause:* Trafodion was unable to create server
+*Cause:* {project-name} was unable to create server
process <name> because it is an unlicensed privileged program. The
server process was configured incorrectly at installation.
@@ -205,11 +205,11 @@ Where <number> is the error number.
Where <name> is the name of the server process.
-*Cause:* The Trafodion database <process-id> received process control
+*Cause:* The {project-name} database <process-id> received process control
procedure error <number> while communicating with the server process
<name>.
-*Effect:* Trafodion is not able to communicate
+*Effect:* {project-name} is not able to communicate
with the process.
*Recovery:* Use the process control procedure error to diagnose and
@@ -229,11 +229,11 @@ Where <number> is the error number.
Where <name> is the name of the server process.
-*Cause:* The Trafodion database <process-id> received process control
+*Cause:* The {project-name} database <process-id> received process control
procedure error <number> while communicating with server process
<name>.
-*Effect:* Trafodion process is not able to
+*Effect:* {project-name} process is not able to
communicate with the server process.
*Recovery:* Use the process control procedure error to diagnose and
@@ -252,7 +252,7 @@ Where <name> is the name of the server process.
Where <number> is the error number.
-*Cause:* The Trafodion database <process-id> was unable to open server
+*Cause:* The {project-name} database <process-id> was unable to open server
process <name> because of the operating system error <number> it
received.
@@ -287,7 +287,7 @@ Where <attribute> is the attribute name you specified.
*Cause:* If the SQLSTATE is 42000, this is an error. You attempted to
set a CONTROL QUERY DEFAULT setting, but the <attribute> name you
-specified is not valid. If the SQLSTATE is 01000, this is a warning. In an earlier Trafodion
+specified is not valid. If the SQLSTATE is 01000, this is a warning. In an earlier {project-name}
database session, you inserted a row into a DEFAULTS table whose
<attribute> column value is invalid.
@@ -329,7 +329,7 @@ will work.
*Recovery:* Informational message only; no corrective action is needed.
This message will be accompanied by an assertion failure message and,
possibly, CONTROL QUERY SHAPE information. However, report the entire
-message, and the preceding assertion failure message, to mailto:user@trafodion.incubator.apache.org[the Trafodion User mailing list].
+message, and the preceding assertion failure message, to {project-support}.
This additional information will also be helpful: the DDL for the tables
involved, the query that produced this warning, and any CONTROL QUERY
@@ -446,7 +446,7 @@ Where <name> is the procedure name.
*Cause:* You defined procedure <name> twice in this module.
-*Effect:* Trafodion uses the first definition.
+*Effect:* {project-name} uses the first definition.
*Recovery:* This is an informational message only; no corrective action
is needed.
@@ -462,7 +462,7 @@ Where <name> is the cursor name.
*Cause:* You defined the static cursor <name> twice in this module.
-*Effect:* Trafodion uses the first static cursor
+*Effect:* {project-name} uses the first static cursor
definition.
*Recovery:* This is an informational message only; no corrective action
@@ -480,7 +480,7 @@ Where <name> is the cursor name.
*Cause:* You defined the static cursor <name> twice in this module.
-*Effect:* Trafodion uses the first dynamic cursor
+*Effect:* {project-name} uses the first dynamic cursor
definition.
*Recovery:* This is an informational message only; no corrective action
@@ -497,7 +497,7 @@ Where <name> is the cursor name.
*Cause:* You defined the dynamic cursor <name> twice in this module.
-*Effect:* Trafodion uses the first static cursor
+*Effect:* {project-name} uses the first static cursor
definition.
*Recovery:* This is an informational message only; no corrective action
@@ -515,7 +515,7 @@ Where <name> is the cursor name.
*Cause:* You defined the dynamic cursor <name> twice in this module.
-*Effect:* Trafodion uses the first dynamic cursor
+*Effect:* {project-name} uses the first dynamic cursor
definition.
*Recovery:* This is an informational message only; no corrective action is needed.
@@ -531,7 +531,7 @@ Where <name> is the statement name.
Where <name> is the module name.
-*Cause:* Trafodion could not find statement <name>
+*Cause:* {project-name} could not find statement <name>
in module <name>.
*Effect:* The operation fails.
@@ -550,7 +550,7 @@ Where <name> is the cursor name.
Where <name> is the module name.
-*Cause:* Trafodion could not find cursor <name> in
+*Cause:* {project-name} could not find cursor <name> in
module <name>.
*Effect:* The operation fails.
@@ -568,7 +568,7 @@ Where <name> is the descriptor name.
*Cause:* You defined the descriptor <name> twice in this module.
-*Effect:* Trafodion uses the first definition.
+*Effect:* {project-name} uses the first definition.
*Recovery:* Informational message only; no corrective action is needed.
@@ -614,7 +614,7 @@ Statement is not valid in this context.
such as SELECT, INSERT, UPDATE, DELETE, or a DDL statement. These
statements must be embedded in procedures.
-*Effect:* Trafodion is unable to compile the
+*Effect:* {project-name} is unable to compile the
module.
*Recovery:* Correct the syntax and resubmit.
@@ -633,7 +633,7 @@ Where <definition-type> is the previous definition
*Cause:* You defined <name> twice in this module in which it was defined
as a type _definition type_.
-*Effect:* Trafodion uses the previous definition.
+*Effect:* {project-name} uses the previous definition.
*Recovery:* Specify a new name for the item and resubmit, if necessary.
@@ -729,14 +729,14 @@ quality.
Error <number> while reading file: <value> bytes were read from <text> when <value> were expected in module <name>.
```
-*Cause:* Trafodion received error <number> while
+*Cause:* {project-name} received error <number> while
reading module <name>. <value> shows the number of bytes read from
<text>. The module file is unusable. Either it has been corrupted or
overwritten.
*Effect:* The operation fails.
-*Recovery:* Recompile the module definition file, using the Trafodion
+*Recovery:* Recompile the module definition file, using the {project-name}
compiler, to create a valid module file.
<<<
@@ -751,10 +751,10 @@ Where <number> is the error number.
Where <name> is the name of the file.
-*Cause:* Trafodion received error <number> while
+*Cause:* {project-name} received error <number> while
opening file <name> for read.
-*Effect:* Trafodion does not open the file.
+*Effect:* {project-name} does not open the file.
*Recovery:* Use the error number to diagnose and correct the problem.
@@ -769,10 +769,10 @@ Where <number> is the error number.
Where <name> is the name of the file.
-*Cause:* Trafodion received error <number> while
+*Cause:* {project-name} received error <number> while
opening file <name> for write.
-*Effect:* Trafodion does not open the file.
+*Effect:* {project-name} does not open the file.
*Recovery:* Use the error number to diagnose and correct the problem.
@@ -788,10 +788,10 @@ Where <number> is the error number.
Where <name> is the name of the file.
-*Cause:* Trafodion received error <number> while
+*Cause:* {project-name} received error <number> while
naming or locating file <name>.
-*Effect:* Trafodion does not name or locate the
+*Effect:* {project-name} does not name or locate the
file.
*Recovery:* Use the error to diagnose and correct the problem.
@@ -803,11 +803,11 @@ file.
Error <number> while writing <value> bytes to file <name>.
```
-*Cause:* Trafodion database software received error <number> while
+*Cause:* {project-name} database software received error <number> while
writing to file <name>. <value> shows the number of bytes being
written.
-*Effect:* Trafodion does not open the file.
+*Effect:* {project-name} does not open the file.
*Recovery:* Use the error to diagnose and correct the problem.
@@ -823,10 +823,10 @@ Where <number> is the error number.
Where <name> is the name of the file.
-*Cause:* Trafodion received error <number> when
+*Cause:* {project-name} received error <number> when
closing file <name>.
-*Effect:* Trafodion does not close the file.
+*Effect:* {project-name} does not close the file.
*Recovery:* Use the error number to diagnose and correct the problem.
@@ -839,12 +839,12 @@ The file <name> could not be purged. This file contains the results of a failed
Where <name> is the name of the file.
-*Cause:* A compilation failed, and for some reason Trafodion database
+*Cause:* A compilation failed, and for some reason {project-name} database
software was not able to purge the module file.
*Effect:* The module file is not valid and should not be used.
-*Recovery:* Purge the file from the Trafodion platform.
+*Recovery:* Purge the file from the {project-name} platform.
<<<
[[SQL-2090]]
@@ -856,7 +856,7 @@ The command line argument for module name, <name-1>, is being ignored in favor o
Where <name-1>, <name-2>, and <name-3> are module file names.
-*Cause:* Trafodion ignored the command line
+*Cause:* {project-name} ignored the command line
argument for module <name-1>. Instead, it used the second module
<name-2> in file <name-3>.
@@ -873,7 +873,7 @@ The required module statement was not found in file <name>.
Where <name> is the name of the file.
-*Cause:* Trafodion could not find the required
+*Cause:* {project-name} could not find the required
module statement in file <name>.
*Effect:* The operation fails.
@@ -893,7 +893,7 @@ Where <name> is the name of the file.
*Cause:* You included more than one module statement. <name> will be
used.
-*Effect:* Trafodion ignores the second module
+*Effect:* {project-name} ignores the second module
statement.
*Recovery:* Informational message only; no corrective action is needed.
@@ -907,10 +907,10 @@ A module timestamp statement was not found in file <name>.
Where <name> is the name of the file.
-*Cause:* Trafodion did not find a module timestamp
+*Cause:* {project-name} did not find a module timestamp
statement in the module definition file <name>.
-*Effect:* Trafodion uses a default timestamp value
+*Effect:* {project-name} uses a default timestamp value
of all zeros.
*Recovery:* Supply a timestamp and resubmit.
@@ -925,7 +925,7 @@ A module timestamp statement has already appeared in this module. The previous t
*Cause:* You specified a timestamp statement twice in this module.
-*Effect:* Trafodion uses the first timestamp.
+*Effect:* {project-name} uses the first timestamp.
*Recovery:* Informational message only; no corrective action is needed.
@@ -938,7 +938,7 @@ Module file <name-1>, expected to contain module <name-2>, instead contains <nam
Where <name-1>, <name-2>, and <name-3> are module file names.
-*Cause:* Trafodion expected to find the first
+*Cause:* {project-name} expected to find the first
module <name-1>, but instead found the second module <name-2>, in file
<name-3>.
@@ -954,7 +954,7 @@ module <name-1>, but instead found the second module <name-2>, in file
A source file statement has already appeared in this module. The previous source file is being retained and this latest one ignored.
```
-*Cause:* The Trafodion compiler was invoked on a module definition file
+*Cause:* The {project-name} compiler was invoked on a module definition file
that contains more than one SOURCE_FILE statement. A module definition
can have only one SOURCE_FILE statement that specifies that module's SQL
source file.
@@ -962,7 +962,7 @@ source file.
*Effect:* The operation fails.
*Recovery:* Edit the module definition file so that it contains no more
-than one SOURCE_FILE statement, and rerun the Trafodion compiler on the
+than one SOURCE_FILE statement, and rerun the {project-name} compiler on the
module definition.
[[SQL-2097]]
@@ -972,7 +972,7 @@ module definition.
Source file name is over 1024 characters long.
```
-*Cause:* The Trafodion compiler was invoked on a module definition file
+*Cause:* The {project-name} compiler was invoked on a module definition file
that contains a SOURCE_FILE statement whose _source path name_ has over
1024 characters.
@@ -980,7 +980,7 @@ that contains a SOURCE_FILE statement whose _source path name_ has over
*Recovery:* Edit the module definition file so that its SOURCE_FILE
statement's _source path name_ is no more than 1024 characters long.
-Rerun the Trafodion compiler on the module definition file.
+Rerun the {project-name} compiler on the module definition file.
<<<
[[SQL-2098]]
@@ -1019,10 +1019,10 @@ Otherwise, correct the syntax and resubmit.
Break was received. The compilation has been aborted.
```
-*Cause:* Trafodion received a break and aborted
+*Cause:* {project-name} received a break and aborted
the compilation.
-*Effect:* Trafodion does not continue compilation.
+*Effect:* {project-name} does not continue compilation.
*Recovery:* Informational message only; no corrective action is needed.
@@ -1033,10 +1033,10 @@ the compilation.
This query could not be compiled with 'MINIMUM' optimization level. Suggestion: Retry with 'MEDIUM' optimization level.
```
-*Cause:* Trafodion was unable to compile this
+*Cause:* {project-name} was unable to compile this
query using the MINIMUM optimization level.
-*Effect:* Trafodion is unable to process this
+*Effect:* {project-name} is unable to process this
query.
*Recovery:* Resubmit the query with MEDIUM optimization level. Precede
@@ -1050,12 +1050,12 @@ the statement with: CONTROL QUERY DEFAULT OPTIMIZATION-LEVEL 'MEDIUM';
This query could not be compiled for one/both of the following reasons: a) Use of 'MINIMUM' optimization level, or b) incompatible Control Query Shape specifications.
```
-*Cause:* Trafodion was unable to compile this
+*Cause:* {project-name} was unable to compile this
query, either because it was not able to use the MINIMUM optimization
level or because you used an incompatible CONTROL QUERY SHAPE
specification.
-*Effect:* Trafodion is unable to process this
+*Effect:* {project-name} is unable to process this
query.
*Recovery:* If applicable, resubmit the query with MINIMUM optimization
@@ -1071,12 +1071,12 @@ QUERY SHAPE specification and resubmit.
This query could not be compiled for one of two reasons: a) incompatible Control Query Shape (CQS) specifications, or b) 'MEDIUM' optimization level is not sufficient to satisfy the CQS in effect. Suggestion: a) inspect the CQS in effect; or b) raise the optimization level to 'MAXIMUM'. Note that for this query, 'MAXIMUM' optimization level may result in a long compile time.
```
-*Cause:* Trafodion was unable to compile this
+*Cause:* {project-name} was unable to compile this
query, either because it was not able to use the MEDIUM optimization
level or because you used an incompatible CONTROL QUERY SHAPE
specification.
-*Effect:* Trafodion is unable to process this
+*Effect:* {project-name} is unable to process this
query.
*Recovery:* If applicable, use the MAXIMUM optimization level, correct
@@ -1090,11 +1090,11 @@ the CONTROL QUERY SHAPE specification, and resubmit.
This query could not be compiled because of incompatible Control Query Shape (CQS) specifications. Inspect the CQS in effect.
```
-*Cause:* Trafodion was unable to compile this
+*Cause:* {project-name} was unable to compile this
query because you used an incompatible CONTROL QUERY SHAPE
specification.
-*Effect:* Trafodion is unable to process this
+*Effect:* {project-name} is unable to process this
query.
*Recovery:* Correct the CONTROL QUERY SHAPE specification and resubmit.
@@ -1106,10 +1106,10 @@ query.
This statement could not be compiled since it is too long. Break up large statements into smaller pieces.
```
-*Cause:* Trafodion was unable to compile this
+*Cause:* {project-name} was unable to compile this
query because it is too long.
-*Effect:* Trafodion is unable to process this
+*Effect:* {project-name} is unable to process this
query.
*Recovery:* Try breaking the statement into smaller pieces.
@@ -1122,7 +1122,7 @@ query.
This statement could not be compiled. Suggestion: Address the issue(s) raised in the reported warning(s).
```
-*Cause:* Trafodion was unable to compile the
+*Cause:* {project-name} was unable to compile the
query.
*Effect:* The operation fails.
@@ -1137,11 +1137,11 @@ diagnose and correct the problem.
Statement was compiled as if query plan caching were off.
```
-*Cause:* Trafodion attempted to compile this query
+*Cause:* {project-name} attempted to compile this query
with query caching on but failed. It then successfully compiled this
query with caching turned off.
-*Effect:* Trafodion compiled the query as if query
+*Effect:* {project-name} compiled the query as if query
plan caching was turned off even though caching is currently on. The
prepared query can be executed as usual.
@@ -1174,12 +1174,12 @@ SQL compilation return code is <mxcmp-non-zero-exit-code>.
*Cause:* You invoked mxCompileUserModule on an application file that has
an embedded module definition. An SQL compilation of an embedded module
-definition resulted in a Trafodion compiler nonzero exit code,
+definition resulted in a {project-name} compiler nonzero exit code,
indicating a warning or error.
*Effect:* The operation fails.
-*Recovery:* Review the Trafodion compiler warning or error message.
+*Recovery:* Review the {project-name} compiler warning or error message.
Trace the diagnostic back to the module source file and correct the
offending source statement. Retry preprocessing, translating, compiling,
and SQL compiling the application file.
@@ -1193,7 +1193,7 @@ and SQL compiling the application file.
```
*Cause:* You invoked mxCompileUserModule on an application file that is
-not a Trafodion platform ELF object file.
+not a {project-name} platform ELF object file.
*Effect:* The operation fails.
@@ -1229,11 +1229,11 @@ Where <module-name> is the name of the module.
*Cause:* You invoked mxCompileUserModule on an application file that has
embedded module definition(s). The SQL compilation of the named embedded
-module definition produced a Trafodion compiler warning or error.
+module definition produced a {project-name} compiler warning or error.
*Effect:* The operation fails.
-*Recovery:* Review the Trafodion compiler warning or error. Trace the
+*Recovery:* Review the {project-name} compiler warning or error. Trace the
diagnostic back to the source file of the named module. Correct
offending source statements. Retry preprocessing, translating,
compiling, and SQL compiling the application file.
@@ -1309,7 +1309,7 @@ application file.
*Effect:* The operation fails.
*Recovery:* Invoke mxCompileUserModule on an application file, such as a
-Trafodion platform ELF object file.
+{project-name} platform ELF object file.
[[SQL-2209]]
== SQL 2209
@@ -1412,7 +1412,7 @@ during the operation.
*Effect:* The operation fails.
-*Recovery:* None. Contact the Trafodion User Distribution List
+*Recovery:* None. Contact the {project-name} User Distribution List
[[SQL-2215]]
== SQL 2215
@@ -1441,16 +1441,16 @@ reserved words and retry the command.
<mxcmp-path> (MXCMP environment variable) does not exist or is not executable.
```
-Where <mxcmp-path> is the Trafodion compiler environment variable.
+Where <mxcmp-path> is the {project-name} compiler environment variable.
-*Cause:* You set your Trafodion compiler environment variable to point
-to your own Trafodion compiler and invoked mxCompileUserModule on an
-application file to SQL compile its module definitions. Your Trafodion
+*Cause:* You set your {project-name} compiler environment variable to point
+to your own {project-name} compiler and invoked mxCompileUserModule on an
+application file to SQL compile its module definitions. Your {project-name}
compiler is not executable.
*Effect:* The operation fails.
-*Recovery:* Verify that your Trafodion compiler exists and is executable
+*Recovery:* Verify that your {project-name} compiler exists and is executable
and retry the command.
[[SQL-2221]]
@@ -1463,7 +1463,7 @@ SQL compiler invocation failed with return code <error-code>.
Where <error-code> is the error message code.
*Cause:* You invoked mxCompileUserModule on an application file to SQL
-compile its module definitions. This command invoked the Trafodion
+compile its module definitions. This command invoked the {project-name}
compiler, which returned _error code,_ indicating an abnormal
termination.
@@ -1471,7 +1471,7 @@ termination.
*Recovery:* If the system is heavily loaded, retry the command later. If
the problem persists under normal system load, report it as an internal
-error and Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+error and contact {project-support}.
<<<
[[SQL-2222]]
[20/22] incubator-trafodion git commit: Merge remote-tracking branch
'origin/master' into TRAFODION-1949
Posted by db...@apache.org.
Merge remote-tracking branch 'origin/master' into TRAFODION-1949
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/4392a832
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/4392a832
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/4392a832
Branch: refs/heads/master
Commit: 4392a8322157a485a4a520a9413e96a2ab3606da
Parents: d7d75f6 ed93ea9
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Wed May 4 22:25:53 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Wed May 4 22:25:53 2016 -0600
----------------------------------------------------------------------
core/sql/executor/ExExeUtil.h | 7 +-
core/sql/executor/ExExeUtilGet.cpp | 55 +++--
core/sql/executor/HBaseClient_JNI.cpp | 227 +++++++++++--------
core/sql/executor/HBaseClient_JNI.h | 66 +++---
core/sql/exp/ExpHbaseInterface.cpp | 39 +---
core/sql/exp/ExpHbaseInterface.h | 18 +-
core/sql/generator/GenRelScan.cpp | 2 +-
core/sql/lib_mgmt/Makefile | 2 +-
core/sql/optimizer/NATable.cpp | 15 +-
core/sql/optimizer/NATable.h | 4 +-
core/sql/optimizer/RelScan.h | 4 +-
core/sql/regress/hive/DIFF018.KNOWN.SB | 10 +
core/sql/regress/udr/EXPECTED001 | 18 +-
core/sql/regress/udr/TEST001 | 4 +-
core/sql/sqlcomp/CmpSeabaseDDL.h | 4 +-
core/sql/sqlcomp/CmpSeabaseDDLcleanup.cpp | 18 +-
core/sql/sqlcomp/CmpSeabaseDDLtable.cpp | 32 +--
.../java/org/trafodion/sql/HBaseClient.java | 35 ++-
.../java/org/trafodion/sql/HTableClient.java | 49 +---
19 files changed, 312 insertions(+), 297 deletions(-)
----------------------------------------------------------------------
[03/22] incubator-trafodion git commit: JDBCT$ Programmer's Reference
Guide
Posted by db...@apache.org.
JDBCT$ Programmer's Reference Guide
New guide. Added missing SPJ Guide file.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/c2116c2b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/c2116c2b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/c2116c2b
Branch: refs/heads/master
Commit: c2116c2b3dd857be5cd28160e0f18d2daca73140
Parents: e5dcfc1
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Fri Apr 29 00:13:43 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Fri Apr 29 00:13:43 2016 -0600
----------------------------------------------------------------------
docs/jdbct4ref_guide/pom.xml | 297 +++
.../src/asciidoc/_chapters/about.adoc | 174 ++
.../src/asciidoc/_chapters/accessing.adoc | 910 ++++++++
.../asciidoc/_chapters/avoiding_mismatch.adoc | 106 +
.../src/asciidoc/_chapters/code_examples.adoc | 56 +
.../src/asciidoc/_chapters/compliance.adoc | 386 ++++
.../src/asciidoc/_chapters/introduction.adoc | 53 +
.../src/asciidoc/_chapters/lob_data.adoc | 553 +++++
.../src/asciidoc/_chapters/lob_management.adoc | 288 +++
.../src/asciidoc/_chapters/messages.adoc | 1943 ++++++++++++++++++
.../asciidoc/_chapters/properties_detail.adoc | 959 +++++++++
.../asciidoc/_chapters/properties_overview.adoc | 245 +++
.../src/asciidoc/_chapters/tracing_logging.adoc | 195 ++
docs/jdbct4ref_guide/src/asciidoc/index.adoc | 74 +
docs/jdbct4ref_guide/src/images/lob_tables.jpg | Bin 0 -> 16241 bytes
.../src/resources/acknowledgements.txt | 38 +
.../src/resources/source/blob_example.java | 202 ++
.../src/resources/source/clob_example.java | 200 ++
.../src/asciidoc/_chapters/sample_spjs.adoc | 6 +-
docs/spj_guide/src/asciidoc/index.adoc | 3 +-
.../src/resources/source/create_demo.sql | 14 +
21 files changed, 6698 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/pom.xml
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/pom.xml b/docs/jdbct4ref_guide/pom.xml
new file mode 100644
index 0000000..413710e
--- /dev/null
+++ b/docs/jdbct4ref_guide/pom.xml
@@ -0,0 +1,297 @@
+<?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>jdbct4-ref-guide</artifactId>
+ <version>${env.TRAFODION_VER}</version>
+ <packaging>pom</packaging>
+ <name>Trafodion JDBC Type 4 Programmer's Reference Guide</name>
+ <description>This document describes how to use the JDBC Type 4 Driver.</description>
+ <url>http://trafodion.incubator.apache.org</url>
+ <inceptionYear>2015</inceptionYear>
+
+ <parent>
+ <groupId>org.apache.trafodion</groupId>
+ <artifactId>trafodion</artifactId>
+ <version>1.3.0</version>
+ <relativePath>../../pom.xml</relativePath>
+ </parent>
+
+
+ <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.11</asciidoctorj.pdf.version>
+ <asciidoctorj.version>1.5.4</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>
+ <project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
+ <build-date>${maven.build.timestamp}</build-date>
+ <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>
+ <project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
+ <build-date>${maven.build.timestamp}</build-date>
+ </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/jdbct4ref_guide/JDBCT4_Reference_Guide.pdf" />
+ <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/${project.version}/jdbct4ref_guide/JDBCT4_Reference_Guide.pdf" />
+ <!-- Copy the Web Book files to their target directories -->
+ <copy todir="${basedir}/../target/docs/jdbct4ref_guide">
+ <fileset dir="${basedir}/target/site">
+ <include name="**/*.*"/> <!--All sub-directories, too-->
+ </fileset>
+ </copy>
+ <copy todir="${basedir}/../target/docs/${project.version}/jdbct4ref_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/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/about.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/about.adoc
new file mode 100644
index 0000000..69bf91d
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/about.adoc
@@ -0,0 +1,174 @@
+////
+/**
+* @@@ 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
+
+This document describes how to use the {project-name} JDBC Type 4 Driver (subsequently called the Type 4 driver).
+This driver provides Java applications running on a foreign platform with JDBC access to {project-name}.
+
+
+== Intended Audience
+This {project-name} JDBC Type 4 Driver Programmer's Reference Guide is for
+experienced Java programmers who want to access {project-name} SQL
+databases.
+
+This document assumes you are already familiar with the Java
+documentation, which is located at http://docs.oracle.com/en/java/.
+
+== 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]
+```
+
+<<<
+== Comments Encouraged
+We encourage 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 {project-support}.
+
+Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc
new file mode 100644
index 0000000..7a6a647
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/accessing.adoc
@@ -0,0 +1,910 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[accessing-project-name-sql-databases]]
+= Accessing {project-name} SQL Databases
+
+[[data-sources]]
+== Data Sources
+
+The term *data source* logically refers to a database or other data
+storage entity. A JDBC (client) data source is physically a Java object that
+contains properties such as the URL of the physical database, the
+catalog to use when connecting to this database, and the schema to use
+when connecting to this database. The JDBC data source also contains
+methods for obtaining a JDBC connection to the underlying database.
+
+[[jdbc-data-source-client-side]]
+=== JDBC Data Source (client-side)
+
+All JDBC data source classes implement either the `javax.sql.DataSource`
+interface or the `javax.sql.ConnectionPoolDataSource` interface. The Type
+4 driver data source classes are `org.trafodion.t4jdbc.HPT4DataSource` and
+`org.trafodion.t4jdbc.HPT4ConnectionPoolDataSource`. (These classes are
+defined by the JDBC 3.0 specification.)
+
+Typically, a user or system administrator uses a tool to create a data
+source, and then registers the data source by using a JNDI service
+provider. At run time, a user application typically retrieves the data
+source through JNDI, and uses the data source's methods to establish a
+connection to the underlying database.
+
+A DataSource object maps to an instance of a database. In the Type 4
+driver product, the DataSource object acts as an interface between the
+application code and the database and enables connection with an DCS
+data source.
+
+[[security]]
+== Security
+
+Clients connect to the {project-name} platform with a valid user name
+and ID, using standard JDBC 3.0 APIs. An application can make multiple
+connections using different user IDs, and creating different Connection
+objects.
+
+The Type 4 driver provides for user name and password authentication.
+The password is encrypted with a proprietary algorithm provided by DCS.
+
+NOTE: There is no secure wire communication such as SSL provided for the
+communication between Type 4 driver and the {project-name} platform.
+
+<<<
+[[connection-by-using-the-datasource-interface]]
+== Connection by Using the DataSource Interface
+
+The `javax.sql.DataSource` interface is the preferred way to establish a
+connection to the database because this interface enhances the application
+portability. Portability is achieved by allowing the application to use a
+logical name for a data source instead of providing driver-specific information
+in the application. A logical name is mapped to a `javax.sql.DataSource`
+object through a naming service that uses the Java Naming and Directory
+Interface (JNDI). Using this DataSource method is particularly recommended
+for application servers.
+
+When an application requests a connection by using the `getConnection` method
+in the `DataSource`, then the method returns a `Connection` object.
+
+A `DataSource` object is a factory for `Connection` objects. An object that
+implements the `DataSource` interface is typically registered with a JNDI
+service provider.
+
+[[overview-of-tasks-to-deploy-datasource-objects]]
+=== Overview of Tasks to Deploy DataSource Objects
+
+Before an application can connect to a `DataSource` object, typically
+the system administrator deploys the `DataSource` object so that
+the application programmers can start using it.
+
+Data source properties are usually set by a system administrator using
+a GUI tool as part of the installation of the data source. Users to
+the data source do not get or set properties. Management tools can get
+at properties by using introspection.
+
+Tasks involved in creating and registering a database object are:
+
+1. Creating an instance of the `DataSource` class.
+2. Setting the properties of the `DataSource` object.
+3. Registering the `DataSource` object with a naming service that uses
+the Java Naming and Directory Interface (JNDI) API.
+
+An instance of the `DataSource` class and the `DataSource` object
+properties are usually set by an application developer or system
+administrator using a GUI tool as part of the installation of the
+data source. If you are using an installed data source, then see
+<<programmatically-creating-an-instance-of-the-datasource-class, Programmatically Creating an Instance of the DataSource Class>>.
+
+The subsequent topics show an example of performing these tasks programmatically.
+
+For more information about using data sources, see https://docs.oracle.com/javase/tutorial/jdbc/basics/sqldatasources.html[Connecting with DataSource Objects]
+in the https://docs.oracle.com/javase/tutorial/jdbc/TOC.html[JDBC(TM) Database Access: Table of Contents] documentation
+or other information available in the field.
+
+<<<
+[[datasource-object-properties]]
+=== DataSource Object Properties
+
+A `DataSource` object has properties that identify and describe the actual
+data source that the object represents. These properties include such
+information as the URL (the primary IP address or host name of the database),
+the database schema and catalog names, the location of the database server,
+the name of the database, and so forth.
+
+For details about Type 4 driver properties that you can use with the `DataSource` object, see <<type-4-driver-properties,Type 4 Driver Properties>>.
+
+[[programmatically-creating-an-instance-of-the-datasource-class]]
+=== Programmatically Creating an Instance of the DataSource Class
+
+A JDBC application can set `DataSource` properties programmatically and
+register with a DataSource object. To get or set `DataSource` object properties programmatically, use the
+appropriate getter or setter methods on the `HPT4DataSource` object or
+the `HPT4ConnectionPoolDataSource` object.
+
+*Example*
+
+[source, java]
+----
+HPT4DataSource temp = new HPT4DataSource() ;
+temp.setCatalog( "Seabase" ) ;
+----
+
+In the following example, the code fragment illustrates the methods that a
+`DataSource` object `ds` needs to include if the object supports the
+`serverDataSource` property `ds.setServerDataSource( "my_server_datasource" )`.
+In this example, the code shows setting properties for the `HPT4DataSource` object
+to use the Type 4 driver to access a {project-name} database:
+
+[source, java]
+----
+HPT4DataSource ds = new HPT4DataSource() ;
+
+ds.setUrl( "jdbc:hpt4jdbc://<primary IP addr or host name>:18650/" );
+ds.setCatalog( "Seabase" ) ;
+ds.setSchema( "myschema" ) ;
+ds.setUser( "gunnar" ) ;
+ds.setPassword( "my_userpassword" ) ;
+
+// Properties relevant for Type 4 connection pooling.
+// Set ds.setMaxPoolSize(-1) for turning OFF connection pooling
+ds.setMaxPoolSize( "10000" ) ;
+ds.setMinPoolSize( "1000" ) ;
+
+// Properties relevant for Type 4 statement pooling.
+// Set ds.setMaxStatement(0) for turning statement pooling OFF
+// Statement pooling is enabled only when connection pooling is
+// enabled.
+ds.setMaxStatements( "7000" ) ;
+----
+
+This technique essentially builds a properties file. For more information,
+see <<creating-and-using-a-properties-file, Creating and Using a Properties File>>.
+
+[[programmatically-registering-the-datasource-object]]
+=== Programmatically Registering the DataSource Object
+
+In the following example, the code shows how to register, programmatically,
+the `HPT4DataSource` object `ds` that was created using the preceding code with JNDI.
+
+[source, java]
+----
+java.util.Hashtable env = new java.util.Hashtable() ;
+env.put( Context.INITIAL_CONTEXT_FACTORY, "Factory class name here" ) ;
+
+javax.naming.Context ctx = new javax.naming.InitialContext( env ) ;
+ctx.rebind( "myDataSource", ds ) ;
+----
+
+[[retrieving-a-datasource-instance-by-using-jndi-and-connecting-to-the-data-source]]
+=== Retrieving a DataSource Instance by Using JNDI and Connecting to the Data Source
+Typically, the JDBC application looks up the data source JNDI name from a
+context object. Once the application has the `DataSource` object, then the application
+does a `getConnection()` call on the data source and gets a connection.
+
+The steps that JDBC application does to connect to and use the data source associated
+with the database are listed below together with the application code to perform the
+operation.
+
+1. Import the packages.
++
+[source, java]
+----
+import javax.naming.* ;
+import java.sql.* ;
+import javax.sql.DataSource ;
+----
+
+2. Create the initial context.
++
+[source, java]
+----
+Hashtable env = new Hashtable() ;
+env.put( Context.INITIAL_CONTEXT_FACTORY, "com.sun.jndi.fscontext.RefFSContextFactory" ) ;
+try
+{
+ Context ctx = new InitialContext( env ) ;
+}
+catch( ... )
+{
+...
+}
+----
++
+<<<
+3. Look up the JNDI name associated with the data source `myDataSource`, where `myDataSource`
+is the logical name that will be associated with the real-world data source - server.
++
+[source, java]
+----
+DataSource ds = (DataSource)ctx.lookup( "myDataSource" ) ;
+----
+
+4. Create the connection using the data source.
++
+[source, java]
+----
+con = ds.getConnection() ;
+----
+
+5. Do work with the connection. The following statements are just a simple example.
++
+[source, java]
+----
+stmt = con.createStatement() ;
+try
+{
+ stmt.executeUpdate( "drop table tdata" ) ;
+}
+catch ( SQLException e ) {}
+----
+
+[[specifying-the-properties-file-that-configures-the-data-source]]
+=== Specifying the Properties File that Configures the Data Source
+
+To use the properties file method to configure a `DataSource` object, the properties
+file must exist on disk and contain the `property_name=property_value` pairs that
+configure the data source.
+See <<creating-and-using-a-properties-file, Creating and Using a Properties File>>
+for more information about creating this file.
+
+When the JDBC application makes the connection, then the application should
+pass the properties file as a command-line parameter:
+
+```
+java -Dhpt4jdbc.properties=<path of properties file on disk>
+```
+
+[[connection-by-using-the-drivermanager-class]]
+== Connection by Using the DriverManager Class
+
+The `java.sql.DriverManager` class is widely used to get a connection, but
+is less portable than the `DataSource` class. The `DriverManager` class
+works with the Driver interface to manage the set of drivers loaded.
+When an application issues a request for a connection using the
+`DriverManager.getConnection` method and provides a URL, the `DriverManager`
+finds a suitable driver that recognizes this URL and obtains a database
+connection using that driver.
+
+`org.trafodion.t4jdbc.HPT4Driver` is the Type 4 driver class that
+implements the `java.sql.Driver` interface.
+
+<<<
+[[loading-and-registering-the-driver]]
+=== Loading and Registering the Driver
+
+Before connecting to the database, the application loads the Driver
+class and registers the Type 4 driver with the DriverManager class in
+one of the following ways:
+
+* Specifies the Type 4 driver class in the `-Djdbc.drivers` option in the
+command line of the Java program:
++
+```
+-Djdbc.drivers=org.trafodion.t4jdbc.HPT4Driver
+```
+
+* Uses the `Class.forName` method programmatically within the application:
++
+[source, java]
+----
+Class.forName("org.trafodion.t4jdbc.HPT4Driver")
+----
+
+* Adds the Type 4 driver class to the `java.lang.System` property
+`jdbc.drivers` property within the application:
++
+```
+jdbc.drivers=org.trafodion.t4jdbc.HPT4Driver
+```
+
+<<<
+[[establishing-the-connection]]
+=== Establishing the Connection
+
+The `DriverManager.getConnection` method accepts a string containing a
+Type 4 driver URL. The JDBC URL for the Type 4 driver is
+
+```
+jdbc:hpt4jdbc://<ip addr or host name>:3700/[:][property=value[;property2=value2]...]
+```
+
+[cols="40%,60%", options="header"]
+|===
+| Parameter | Usage
+| `<ip addr or host name>` | The primary IP address or host name for the {project-name} database.
+| `37800` | The port number for the {project-name} SQL database.
+| `property = value` and `property2=value2` | Specifies a Type 4 driver property name-property value pair. The pairs must be separated by a
+semicolon (`;`). For example, `T4LogLevel=ALL;T4LogFile=temp1.log`.
+|===
+
+For information about the properties file, see <<type-4-driver-properties,Type 4 Driver Properties>>.
+
+To establish a connection, the JDBC application can use this code:
+
+[source, java]
+----
+Class.forName( "org.trafodion.t4jdbc.HPT4Driver" ) ; //loads the driver
+
+String url = "jdbc:hpt4jdbc://<database primary IP address>:37800/"
+
+Connection con = DriverManager.getConnection( url, "userID", "Passwd" ) ;
+----
+
+The variable con represents a connection to the data source that can be
+used to create and execute SQL statements.
+
+[[guidelines-for-connections-using-the-driver-manager]]
+=== Guidelines for Connections Using the Driver Manager
+
+* The Type 4 driver defines a set of properties that you can use to
+configure the driver. For detailed information about these properties,
+see <<type-4-driver-properties,Type 4 Driver Properties>>.
+* Java applications can specify the properties in these ways (listed in
+the order of precedence):
++
+1. Using the `java.util.Properties` parameter in the `getConnection` method of DriverManager class.
+
+2. Using the database URL in the `DriverManager.getconnection` method, where the URL is:
++
+```
+jdbc:hpt4jdbc://<ip addr or host name>:37800/:property=value
+```
++
+`<ip addr or host name>` is the primary IP address or host name for the {project-name} database.
++
+<<<
+3. Using a properties file for the JDBC driver. The properties file is
+passed as a command-line parameter. The format to enter the properties
+file in the command line is:
++
+```
+-Dhpt4jdbc.properties=<path of properties file on disk>
+```
++
+For example, `-Dhpt4jdbc.properties=C:\temp\t4props`
++
+For information about the properties file, see <<creating-and-using-a-properties-file, Creating and Using a Properties File>>.
+4. Using JDBC properties with the `-D` option in the command line. If
+used, this option applies to all JDBC connections using the
+`DriverManager` within the Java application. The format in the command
+line is:
++
+```
+-Dhpt4jdbc.property_name=<property value>
+```
++
+For example, `-Dhpt4jdbc.maxStatements=1024`
+
+<<<
+[[connection-pooling]]
+== Connection Pooling
+
+The Type 4 driver provides an implementation of connection pooling,
+where a cache of physical database connections are assigned to a client
+session and reused for the database activity. If connection pooling is
+active, connections are not physically closed. The connection is
+returned to its connection pool when the `Connection.close()` method is
+called. The next time a connection is requested by the client, the
+driver will return the pooled connection, and not a new physical
+connection.
+
+* The connection pooling feature is available when the JDBC application
+uses either the `DriverManager` class or `DataSource` interface to obtain a
+JDBC connection. The connection pool size is determined by the
+`maxPoolSize` property value and `minPoolSize` property value.
+
+* By default, connection pooling is disabled. To enable connection
+pooling, set the maxPoolSize property to an integer value greater than 0
+(zero).
+
+* Manage connection pooling by using these Type 4 driver properties:
+
+** `maxPoolSize` under <<maxpoolsize-property, maxpoolsize Property>>
+** `minPoolSize` under <<minpoolsize-property, minPoolSize Property>>
+** `initialPoolSize` under <<initialpoolsize-property, initialPoolSize Property>>
+** `maxStatements` under <<maxstatements-property, maxStatements Property>>
+
+* When used with the DriverManager class, the Type 4 driver has a
+connection-pool manager that determines which connections are pooled
+together by a unique value for these combination of properties:
++
+```
+url
+catalog
+schema
+username
+password
+serverDataSource
+```
++
+Therefore, connections that have the same values for the combination of
+a set of properties are pooled together.
++
+NOTE: The connection-pooling property values used at the first
+connection of a given combination are effective throughout the life of
+the process. An application cannot change any of these property values
+after the first connection for a given combination.
+
+<<<
+[[statement-pooling]]
+== Statement Pooling
+
+The statement pooling feature allows applications to reuse the
+PreparedStatement object in the same way that they can reuse a
+connection in the connection pooling environment. Statement pooling is
+completely transparent to the application.
+
+[[guidelines-for-statement-pooling]]
+=== Guidelines for Statement Pooling
+
+* To enable statement pooling, set the `maxStatements` property to an
+integer value greater than 0 and enable connection pooling. For more
+information, see <<initialpoolsize-property, initialPoolSize Property>> and
+<<connection-pooling, Connection Pooling>>.
+
+* Enabling statement pooling for your JDBC applications might
+dramatically improve the performance.
+
+* Explicitly close a prepared statement by using the `Statement.close`
+method because `PreparedStatement` objects that are not in scope are also
+not reused unless the application explicitly closes them.
+
+* To ensure that your application reuses a `PreparedStatement`, call
+either of these methods:
+
+** `Statement.close method`: called by the application.
+** `Connection.close method`: called by the application. All the
+`PreparedStatement` objects that were in use are ready to be reused when
+the connection is reused.
+
+[[troubleshooting-statement-pooling]]
+=== Troubleshooting Statement Pooling
+
+Note the following Type 4 driver implementation details if you are
+troubleshooting statement pooling:
+
+* The Type 4 driver looks for a matching `PreparedStatement` object in the
+statement pool and reuses the `PreparedStatement`. The matching criteria
+include the SQL string, catalog, current schema, current transaction
+isolation, and result set holdability.
++
+If the Type 4 driver finds the matching `PreparedStatement` object, then the
+driver returns the same `PreparedStatement` object to the application for reuse
+and marks the `PreparedStatement` object as in use.
+
+* The algorithm, _earlier used are the first to go_, is used to make
+room for caching subsequently generated `PreparedStatement` objects when
+the number of statements reaches the `maxStatements` limit.
+
+* The Type 4 driver assumes that any SQL CONTROL statements in effect at
+the time of execution or reuse are the same as those in effect at the time
+of SQL compilation.
++
+If this condition is not true, then reuse of a `PreparedStatement` object might
+result in unexpected behavior.
+
+* Avoid recompiling to yield performance improvements from statement
+pooling. The SQL executor automatically recompiles queries when certain conditions are met.
+Some of these conditions are:
+
+** A run-time version of a table has a different redefinition timestamp
+than the compile-time version of the same table.
+
+** An existing open operation on a table was eliminated by a DDL or SQL
+utility operation.
+
+** The transaction isolation level and access mode at execution time is
+different from that at the compile time.
+
+* When a query is recompiled, then the SQL executor stores the recompiled query;
+therefore, the query is recompiled only once until any of the previous conditions
+are met again.
+
+* The Type 4 driver does not cache `Statement` objects.
+
+[[thread-safe-database-access]]
+== Thread-Safe Database Access
+
+In the Type 4 driver, API layer classes are implemented as
+instance-specific objects to ensure thread safety:
+
+* `HPT4DataSource.getConnection()` is implemented as a synchronized method
+to ensure thread safety in getting a connection.
+
+* Once a connection is made, the `Connection` object is instance-specific.
+
+* If multiple statements are run on different threads in a single
+connection, then statement objects are serialized to prevent data corruption.
+
+[[update-where-current-of-operations]]
+== "Update . . . Where Current of" Operations
+
+The fetch size on a `ResultSet` must be 1 when performing an
+`update . . . where current of` _cursor_ SQL statement.
+
+If the value of the fetch size is greater than 1, the result of the
+`update . . . where current` of operation might be one of the following:
+
+* An incorrect row might be updated based on the actual cursor position.
+
+* An SQLException might occur because the cursor being updated might
+have already been closed.
+
+The following is an example of setting a result set's fetch size to 1
+and executing an `update . . . where current` of _cursor_ SQL statement.
+
+[source, java]
+----
+ResultSet rs ;
+ ...
+
+ rs.setFetchSize( 1 ) ;
+ String st1 = rs.getCursorName() ;
+
+ Statement stmt2 =
+ connection.createStatement( ResultSet.TYPE_FORWARD_ONLY
+ , ResultSet.CONCUR_UPDATABLE
+ ) ;
+ stmt2.executeUpdate( "UPDATE cat2.sch2.table1
+ SET j = 'update row' WHERE CURRENT OF "
+ + st1
+ ) ;
+----
+
+[[infostats-command-for-obtaining-query-costs]]
+== INFOSTATS Command for Obtaining Query Costs
+
+The INFOSTATS command reports the roll-up costs of a particular query.
+INFOSTATS is a pass-through command that collects statistics for a
+prepared statement. Statistics are returned to the JDBC application as a
+result set as soon as the prepare is finished. The result set has these
+columns:
+
+[cols="30%,70%",options="header" ]
+|===
+| Column | Description
+| `Query ID (SQL_CHAR)` | The unique identifier for the query.
+| `CPUTime (SQL_DOUBLE)` | An estimate of the number of seconds of processor time it might take to execute the instructions for this query. A value of 1.0 is 1 second.
+| `IOTime (SQL_DOUBLE)` | An estimate of the number of seconds of I/O time (seeks plus data transfer) to perform the I/O for this query.
+| `MsgTime (SQL_DOUBLE)` | An estimate of the number of seconds it takes for the messaging for this query. The estimate includes the time for the number of local and remote
+messages and the amount of data sent.
+| `IdleTime (SQL_DOUBLE)` | An estimate of the maximum number of seconds to wait for an event to happen for this query. The estimate includes the amount of time to open
+a table or start an ESP process.
+| `TotalTime (SQL_DOUBLE)` | Estimated cost associated to execute the query.
+| `Cardinality (SQL_DOUBLE)` | Estimated number of rows that will be returned.
+|===
+
+<<<
+[[use-of-the-infostats-command]]
+=== Use of the INFOSTATS Command
+
+The INFOSTATS command can only be used with PreparedStatement objects.
+The syntax is:
+
+```
+INFOSTATS cursor_name
+```
+
+where `cursor_name` is the name of the prepared statement. If the cursor name is case-sensitive,
+then enclose it in single quotes.
+
+To get the cursor name, use the `getStatementLabel()` method that is
+defined for the {project-name} JDBC Type 4 driver with class:
+
+[source, java]
+----
+org.trafodion.t4jdbc.HPT4PreparedStatement: public String
+getStatementLabel() ;
+----
+
+*Considerations*
+
+* You can use INFOSTATS in these methods only:
++
+[source, java]
+----
+java.sql.Statement.executeQuery(String sql)
+java.sql.Statement.execute(String sql)
+----
+
+* `setCursorName` is not supported with INFOSTATS.
+
+* If you invoke INFOSTATS incorrectly, the Type 4 driver issues this error:
++
+```
+Message: INFOSTATS command can only be executed
+ by calling execute(String sql) method.
+ Sqlstate HY000
+ Sqlcode 29180
+```
+
+<<<
+*Example of INFOSTATS*
+
+[source, java]
+----
+Statement s = conn.createStatement( ) ;
+
+HPT4PreparedStatement p =
+ (HPT4PreparedStatement)conn.prepareStatement(
+ "SELECT * FROM t WHERE i = ?" ) ;
+
+boolean results = s.execute( "INFOSTATS " + p.getStatementLabel() ) ;
+
+if ( results )
+{
+ ResultSet rs = s.getResultSet( ) ;
+
+ while ( rs.next( ) )
+ {
+ //process data
+ }
+}
+----
+
+*Sample Output*
+
+```
+QueryID: MXID001001128212016369912348191_16_SQL_CUR_9829657
+CPUTime: 0.09975778464794362
+IOTime: 0.10584000146627659
+MsgTime: 0.09800000134418951
+IdleTime: 0.09800000134418951
+TotalTime: 0.10584000146627659
+Cardinality: 100.0
+```
+
+<<<
+[[internationalization-support]]
+== Internationalization Support
+
+[[when-string-literals-are-used-in-applications]]
+=== When String Literals Are Used in Applications
+
+Internationalization support in the driver affects the handling of
+string literals. The Type 4 driver handles string literals in two
+situations.
+
+1. When the driver processes an SQL statement. For example,
++
+[source, java]
+----
+Statement stmt = connection.getStatement() ;
+
+stmt.execute( "SELECT * FROM table1 WHERE col1 = 'abcd'" ) ;
+----
+
+2. When the driver processes JDBC parameters. For example,
++
+[source, java]
+----
+PreparedStatement pStmt = connection.prepareStatement(
+ "SELECT * FROM table1 WHERE col1 = ?" ) ;
+pStmt.setString( 1, "abcd" ) ;
+----
+
+To convert a string literal from the Java to an array of bytes for
+processing by the {project-name}, the Type 4 driver uses
+the column type in the database.
+
+[[controlling-string-literal-conversion-by-using-the-character-set-properties]]
+=== Controlling String Literal Conversion by Using the Character-Set Properties
+
+The Type 4 driver provides character-set mapping properties. These
+properties allow you to explicitly define the translation of internal
+SQL character-set formats to and from the Java string Unicode (`UnicodeBigUnmarked`)
+encoding.
+
+The Type 4 driver provides character-set mapping properties through key
+values as shown in the following table.
+
+[cols="50%,50%",options="header" ]
+|===
+| Key | Default Value
+| `ISO88591` | `ISO88591_1`
+| `KANJI` | `SJIS`
+| `KSC5601` | `EUC_KR`
+|===
+
+<<<
+A description of these character sets appears in table below, which
+summarizes the character sets supported by {project-name}.
+
+[cols="25%,35%,40%",options="header" ]
+|===
+| {project-name} Character Set | Corresponding Java Encoding Set^1^ | Description
+| ISO88591 | ISO88591_1 | Single-character, 8-bit character-data type ISO88591 supports English and other Western European languages.
+|===
+
+^1^ Canonical Name for `java.io` and `java.lang` API.
+
+For detailed information, see <<iso88591-property, ISO88591 Property>>.
+
+[[using-the-character-set-properties]]
+==== Using the Character-Set Properties
+
+The `java.sql.PreparedStatement` class contains the methods `setString()`
+and `setCharacterStream()`. These methods take a String and Reader
+parameter, respectively.
+
+The `java.sql.ResultSet` class contains the methods `getString()` and
+`getCharacterStream()`. These methods return a String and Reader, respectively.
+
+[[retrieving-a-column]]
+===== Retrieving a Column
+
+When you retrieve a column as a string (for example, call the
+`getString()` or `getCharacterStream` methods), the Type 4 driver uses the
+character-set mapping property key to instantiate a String object (where
+that key corresponds to the character set of the column).
+
+*Example*
+
+The following `SQL CREATE TABLE` statement creates a table that has an
+`ISO88591` column.
+
+[source, sql]
+----
+CREATE TABLE t1 ( c1 CHAR(20) CHARACTER SET ISO88591 ) ;
+----
+
+The JDBC program uses the following java command to set the ISO88591
+property and issues the `getString()` method.
+
+[source, java]
+----
+java -Dhpt4jdbc.ISO88591=SJIS test1.java
+
+// The following method invocation returns a String object, which
+// was created using the "SJIS" Java canonical name as the charset
+// parameter to the String constructor.
+String s1 = rs.getString( 1 ) ; // get column 1 as a String
+----
+
+[[setting-a-parameter]]
+===== Setting a Parameter
+
+When you set a parameter by using a String (for example, call the
+`setString()` method), the Type 4 driver uses the key's value when
+generating the internal representation of the String (where that
+key corresponds to the character set of the column). The
+character-set parameter to the String `getBytes` method is the Java
+Canonical name that corresponds to the column's character set.
+
+*Example*
+
+The following `SQL CREATE TABLE` statement creates a table
+that has an ISO88591 column:
+
+```
+CREATE TABLE t1 ( c1 CHAR(20) CHARACTER SET ISO88591) ;
+> java -DISO88591=SJIS test1.java
+```
+
+The following method invocation sets column one of `stmt` to the String
+"abcd" where "abcd" is encoded as SJIS. The charset parameter to the
+String `getBytes` method is SJIS `stmt.setString( 1, "abcd" ) ;`.
+
+[[controlling-what-happens-on-an-exception]]
+==== Controlling What Happens on an Exception
+
+You can use the `translationVerification` property to explicitly define
+the behavior of the driver if the driver cannot translate all or part of
+an SQL parameter. The value portion of the property can be `TRUE` or
+`FALSE`. (The default value is `FALSE`).
+
+If the `translationVerification` property's value is `FALSE` and the driver
+cannot translate all or part of an SQL statement, then the translation is
+unspecified. In most cases, the characters that are untranslatable are
+encoded as ISO88591 single-byte question marks (`'?'` or `0x3F`). No
+exception or warning is thrown.
+
+If the `translationVerification` property's value is TRUE and the driver
+cannot translate all or part of an SQL statement, then the driver throws an
+`SQLException` with the following text:
+
+```
+Translation of parameter to {0} failed. Cause: {1}
+```
+
+where `{0}` is replaced with the target character set and `{1}` is
+replaced with the cause of the translation failure.
+
+For more information, see
+<<translationverification-property, translationVerification Property>>.
+
+<<<
+[[localizing-error-messages-and-status-messages]]
+=== Localizing Error Messages and Status Messages
+
+The Type 4 driver supports Internationalization through resource bundles
+for localized error messages and status messages. The driver uses a set
+of static strings from a property file to map error messages and status
+messages to their textual representation.
+
+[[file-name-format-for-the-localized-messages-file]]
+==== File-Name Format for the Localized-Messages File
+
+The property file that has the messages must have a file name in the
+form:
+
+```
+HPT4Messages_xx.properties
+```
+
+where `xx` is the locale name. The locale name is defined by the current
+default locale or by the language property.
+
+The Type 4 driver is shipped with an error messages and status messages
+property file that contains the textual representation of errors and
+status messages for the English locale. The file is named
+`HPT4Messages_en.properties`.
+
+[[localized-message-string-format]]
+==== Localized-Message String Format
+
+A localized message file contains strings in the form:
+
+```
+message=message_text
+```
+
+*Example*
+
+```
+driver_err_error_from_server_msg=An error was returned from the server.
+Error: {0} Error detail: {1}
+```
+
+where the `message` is `driver_err_error_from_server_msg`. The
+`message_text` is: `An error was returned from the server. Error: {0} Error detail: {1}`
+
+The pattern `{n}` in `message_text`, where `n` equals 1, 2, 3, and
+so forth, is a placeholder that is filled in at run time by the Type 4
+driver. Any translation must include these placeholders.
+
+<<<
+[[procedure-to-create-a-localized-message-file]]
+==== Procedure to Create a Localized-Message File
+
+1. Extract the `HPT4Messages_en.properties file`, which is in the
+`hpt4jdbc.jar file`.
++
+*Example*
++
+From a UNIX prompt, use the jar Java tool: `jar -x HPT4Messages_en.properties < hpt4jdbc.jar`
+
+2. Copy the file.
+
+3. Edit the file and replace the English text with the text for your locale.
+
+4. Save the file, giving it a file name that meets the naming
+requirements described under
+<<file-name-format-for-the-localized-messages-file, File-Name Format for the Localized-Messages File>>.
+
+5. Put the file in a directory anywhere in the class path for running the JDBC application.
+
+The new messages file can be anywhere in the class path for running the
+user application.
+
+At run time, if driver cannot read the messages property file, the
+driver uses the `message` portion of the property as the text of the
+message. For a description of the message portion, see the
+<<localized-message-string-format, Localized-Message String Format>>.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc
new file mode 100644
index 0000000..8d40e10
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/avoiding_mismatch.adoc
@@ -0,0 +1,106 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[avoiding-driver-server-version-mismatch]]
+= Avoiding Driver-Server Version Mismatch
+
+The {project-name} JDBC type 4 driver described in this
+document can connect only with an version-equivalent platform
+(server). It cannot connect with an earlier version platform.
+
+To make a connection with the {project-name} platform, JDBC clients,
+through the driver, connect with the {project-name} database
+connectivity service (DCS) on the {project-name} platform. In some
+situations, {project-name} JDBC clients need to make connections to
+older-version platforms (servers) from the same client boxes.
+To make a connection, the driver version
+must be compatible with the {project-name} platform version.
+
+NOTE: The DCS release version and {project-name} platform release
+version are always the same.
+
+
+[[compatible-versions]]
+== Compatible Versions
+
+Ensure that you install the driver version that is compatible with the
+{project-name} platform version.
+
+
+[cols=",",options="header" ]
+|===
+| Driver version | Compatible versions of the {project-name} platform
+| {project-name} Release 2.0 driver | All versions up to, but not including, {project-name} Release 2.2
+| {project-name} Release 2.1 driver | All versions up to, but not including, {project-name} Release 2.2
+| {project-name} Release 2.2 driver | {project-name} Release 2.2 and later versions
+|===
+
+If a compatible version is not installed, you can obtain the software to
+download from the {project-name} download site.
+
+[[considerations-for-mixed-version-jdbc-clients-connecting-to-project-name-platforms]]
+== Considerations for Mixed-Version JDBC Clients Connecting to {project-name} Platforms
+
+On the client platform, you can install multiple versions of the
+{project-name} JDBC type 4 driver to connect to {project-name}
+platforms of different platform versions.
+
+* Assuming you have installed the Release 2.2 {project-name} JDBC type
+4 driver on your workstation and set up the client environment, the 2.2
+driver's classes are set your java CLASSPATH.
+* To connect to a Release 2.1 or 2.0 server ({project-name} platform)
+from the same client machine, you must load the 2.1 driver by making
+sure that it is in your java CLASSPATH.
+* Connecting to both a 2.1 and 2.2 server from the same application at
+the same time is not possible.
+* A given application must use either the 2.2 driver or the 2.1 driver
+when launched. The only way to switch is to reload the application when
+pointing to a new CLASSPATH that contains a different driver.
+
+[[version-mismatch-error-message]]
+== Version Mismatch Error Message
+
+If an {project-name} JDBC client attempts to connect to an invalid DCS
+version, the driver returns the error:
+
+```
+SQLCODE: 29162
+SQLSTATE S1000
+
+Error text:
+
+Unexpected programming exception has been found: <errortext>. Check
+the server event log on node <logfile_location> for details.
+```
+
+* <errortext> is the error text from the server.
+* <logfile_location> is the location of the log file.
+
+Additional error text returned only by a Release 2.2 server, but displayed by any version driver:
+
+```
+Version Mismatch: Client Version is: Pre R2.2.0 Server Version is:
+R2.2.0 Server vproc is:
+
+T7969N25_10AUG07_N25_AS_0613 ERROR
+```
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/code_examples.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/code_examples.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/code_examples.adoc
new file mode 100644
index 0000000..b8471e3
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/code_examples.adoc
@@ -0,0 +1,56 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[sample-programs-accessing-clob-and-blob-data]]
+= Sample Programs Accessing CLOB and BLOB Data
+
+This appendix shows two working programs.
+
+[[sample-program-accessing-clob-data]]
+== Sample Program Accessing CLOB Data
+
+This sample program shows operations that can be performed through the
+Clob interface or through the PreparedStatement interface. The sample
+program shows examples of both interfaces taking a variable and putting
+the variable's value into a base table that has a CLOB column.
+
+You can access the source at: http://trafodion.apache.org/docs/jdbct4ref_guide/resources/source/clob_example.java
+
+[source, java]
+----
+include::{sourcedir}/clob_example.java[CLOB Example]
+----
+
+[[sample-program-accessing-blob-data]]
+== Sample Program Accessing BLOB Data
+
+This sample program shows the use of both the Blob interface and the
+PreparedStatement interface to take a byte variable and put the
+variable's value into a base table that has a BLOB column.
+
+You can access the source at: http://trafodion.apache.org/docs/jdbct4ref_guide/resources/source/blob_example.java
+
+[source, java]
+----
+include::{sourcedir}/blob_example.java[BLOB Example]
+----
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc
new file mode 100644
index 0000000..25eedf1
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/compliance.adoc
@@ -0,0 +1,386 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[type-4-driver-compliance]]
+= Type 4 Driver Compliance
+
+[[compliance-overview]]
+== Compliance Overview
+
+The Type 4 driver conforms where applicable to the JDBC
+3.0 API specification. However, this driver differs from the JDBC
+standard in some ways. This subsection describes the JDBC methods that
+are not supported, the methods and features that deviate from the
+specification, and features that are {project-name} extensions to the JDBC standard.
+JDBC features that conform to the specification are not described in this subsection.
+
+In addition, this chapter lists features of {project-name} SQL that are not supported by the {project-name} JDBC Type 4 driver, other
+unsupported features, and restrictions.
+
+[[unsupported-features]]
+== Unsupported Features
+
+These methods in the java.sql package throw an SQLException with the
+message `Unsupported feature - <method-name>`:
+
+[cols="65%,35%", options="header"]
+|===
+| Method | Comments
+| `CallableStatement.getArray(int parameterIndex)` +
+`CallableStatement.getArray(String parameterName)` +
+`CallableStatement.getBlob(int parameterIndex)` +
+`CallableStatement.getBlob(String parameterName)` +
+`CallableStatement.getClob(int parameterIndex)` +
+`CallableStatement.getClob(String parameterName)` +
+`CallableStatement.getObject(int parameterIndex, Map map)` +
+`CallableStatement.getObject(String parameterName, Map map)` +
+`CallableStatement.getRef(int parameterIndex)` +
+`CallableStatement.getRef(String parameterName)` +
+`CallableStatement.getURL(int parameterIndex)` +
+`CallableStatement.getURL(String parameterName)` +
+`CallableStatement.executeBatch()` | The particular `CallableStatement` method is not supported.
+| `Connection.releaseSavepoint(Savepoint savepoint)` +
+`Connection.rollback(Savepoint savepoint)` +
+`Connection.setSavepoint()` +
+`Connection.setSavepoint(String name)` | The particular `Connection` methods are not supported.
+| `PreparedStatement.setArray(int parameterIndex, Array x)` +
+`PreparedStatement.setRef(int parameterIndex, Ref x)` +
+`PreparedStatement.setURL(int parameterIndex, URL x)` | The particular `PreparedStatement` methods are not supported.
+| `ResultSet.getArray(int columnIndex)` +
+`ResultSet.getArray(String columnName)` +
+`ResultSet.getObject(int columnIndex, Map map)` +
+`ResultSet.getObject(String columnName, Map map)` +
+`ResultSet.getRef(int columnIndex)ResultSet.getRef(String columnName)` +
+`ResultSet.getURL(int columnIndex)` +
+`ResultSet.getURL(String columnName)` +
+`ResultSet.updateArray(int columnIndex)` +
+`ResultSet.updateArray(String columnName)` +
+`ResultSet.updateRef(int columnIndex)` +
+`ResultSet.updateRef(String columnName) | The particular `ResultSet` methods are not supported.
+| `Statement.getQueryTimeout()` +
+`Statement.setQueryTimeout()` | The particular `Statement` methods are not supported.
+|===
+
+The following methods in the java.sql package throw an SQLException with
+the message `Auto generated keys not supported`:
+
+[cols="65%,35%", options="header" ]
+|===
+| Method | Comments
+| `Connection.prepareStatement(String sql, int autoGeneratedKeys)` +
+`Connection.prepareStatement(String sql, int[] columnIndexes)` +
+`Connection.prepareStatement(String sql, String[] columnNames)` | Automatically generated keys are not supported.
+| `Statement.executeUpdate(String sql, int autoGeneratedKeys)` +
+`Statement.executeUpdate(String sql, int[] columnIndexes)` +
+`Statement.executeUpdate(String sql, String[] columnNames)` +
+`Statement.getGeneratedKeys()` | Automatically generated keys are not supported.
+|===
+
+The following methods in the java.sql package throw an SQLException with
+the message `Data type not supported`:
+
+[cols="65%,35%", options="header" ]
+|===
+| Method | Comments
+| `CallableStatement.getBytes(int parameterIndex)` +
+`CallableStatement.setBytes(String parameterIndex, bytes[] x)` | The particular data type is not supported.
+|===
+
+The following interfaces in the `java.sql` package are not implemented in
+the Type 4 driver:
+
+[cols="65%,35%", options="header" ]
+|===
+| Method | Comments
+| `java.sql.Array` +
+`java.sql.Ref` +
+`java.sql.Savepoint` +
+`java.sql.SQLData` +
+`java.sql.SQLInput` +
+`java.sql.SQLOutput` +
+`java.sql.Struct` | The underlying data types are not supported by {project-name}.
+|===
+
+<<<<
+The following interfaces in the `javax.sql` package are not implemented in the Type 4 driver:
+
+[cols="65%,35%", options="header" ]
+|===
+| Method | Comments
+| `javax.sql.XAConnection` +
+`javax.sql.XADataSource` | Distributed Transactions, as described in the JDBC 3.0 API specification, are not yet implemented.
+|===
+
+For additional information about deviations for some methods, see <<deviations, Deviations>>.
+
+[[deviations]]
+== Deviations
+
+The following table lists methods that differ in execution from the JDBC
+specification. When an argument in a method is ignored, the Type 4
+driver does not throw an SQLException,thus allowing the application to
+continue processing. The application might not obtain the expected
+results, however. Other methods listed do not necessarily throw an
+SQLException, unless otherwise stated, although they differ from the
+specification.
+
+NOTE: The `java.sql.DatabaseMetaData.getVersionColumns()` method mimics the
+`java.sql.DatabaseMetaData.getBestRowIdentifier()` method because
+{project-name} SQL does not support `SQL_ROWVER` (a columns function that
+returns the column or columns in the specified table, if any, that are
+automatically updated by the data source when any value in the row is
+updated by any transaction).
+
+[cols="50%,50%", options="header" ]
+|===
+| Method | Comments
+| `java.sql.DatabaseMetaData.getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)` |
+The column is added to the column data, but its value is set to NULL because {project-name} SQL does not support the column type for these types: +
+ +
+`SCOPE_CATALOG,` +
+`SCOPE_SCHEMA,` +
+`SCOPE_TABLE,` +
+and `SOURCE_DATA_TYPE`
+| `java.sql.DatabaseMetaData.getTables(String catalog, String schemaPattern, String[] types)` |
+The column is added to the column data, but its value is set to NULL because {project-name} SQL does not support the column type for these types: +
+ +
+`TYPE_CAT,` +
+`TYPE_SCHEMA,` +
+`TYPE_NAME,` +
+`SELF_REFERENCING_COL_NAME,` +
+and `REF_GENERATION.`
+| `java.sql.DatabaseMetaData.getUDTs(String catalog, String schemaPattern, String tableNamePattern, int[] types)` |
+BASE_TYPE is added to the column data, but its value is set to NULL because {project-name} SQL does not support the base type.
+| `java.sql.DatabaseMetaData.getVersionColumns()` |
+Mimics the `DatabaseMetaData.getBestRowIdentifier()` method because {project-name} SQL does not support `SQL_ROWVER` (a columns function that returns the
+column or columns in the specified table, if any, that are automatically updated by the data source when any value in the row is updated by any transaction).
+| `java.sql.Connection.createStatement(. . .)` +
+`java.sql.Connection.prepareStatement(. . .)` |
+The Type 4 driver does not support the scroll-sensitive result set type, so an SQL Warning is issued if an application requests that type. The result set is changed to
+a scroll-insensitive type.
+| `java.sql.ResultSet.setFetchDirection(. . .)` | The fetch direction attribute is ignored.
+| `java.sql.Statement.cancel()` |
+In some instances, drops the connection to the server instead of just canceling the query. You must then reconnect to the server.
+Note that the connection is dropped if `cancel()` is issued for a statement that is being processed. Otherwise the connection is maintained.
+| `java.sql.Statement.setEscapeProcessing(. . .)` | Because {project-name} SQL parses the escape syntax, disabling escape processing has no effect.
+| `java.sql.Statement.setFetchDirection(. . .)` | The fetch direction attribute is ignored.
+|===
+
+<<<
+[[project-name-extensions]]
+== {project-name} Extensions
+
+The {project-name} extensions to the JDBC standard implemented in the Type 4 driver are as follows.
+
+[[internationalization-of-messages]]
+=== Internationalization of Messages
+
+The Type 4 driver is designed so that Java messages can be adopted for
+various languages. The error messages are stored outside the source code
+in a separate property file and retrieved dynamically based on the
+locale setting. The error messages in different languages are stored in
+separate property files based on the language and country. This
+extension does not apply to all messages that can occur when running
+JDBC applications.
+
+For details, see <<localizing-error-messages-and-status-messages, Localizing Error Messages and Status Messages>>.
+
+[[additional-databasemetadata-apis]]
+=== Additional DatabaseMetaData APIs
+
+APIs added to the `HPT4DatabaseMetaData` class provide these capabilities:
+
+* Get a description of a table's synonyms.
++
+[source, java]
+----
+public java.sql.ResultSet getSynonymInfo(String catalog, String schema, String table) throws SQLException
+----
+
+////
+* Get a description of a table's materialized views.
++
+[source, java]
+----
+public java.sql.ResultSet getMaterializedViewInfo(String catalog, String schema, String table) throws SQLException
+----
+////
+
+[[additional-connection-apis]]
+=== Additional Connection APIs
+
+APIs added to the `HPT4Connection` class provide these capabilities:
+
+* Sets the current service name for this Connection object.
++
+[source, java]
+----
+public void setServiceName(String serviceName) throws SQLException
+----
+
+* Gets (retrieves) the current service name of this Connection object. Default return value: HP_DEFAULT_SERVICE.
++
+[source, java]
+----
+public String getServiceName() throws SQLException
+----
+
+[[conformance-of-databasemetadata-methods-handling-of-null-parameters]]
+== Conformance of DatabaseMetaData Methods' Handling of Null Parameters
+
+This topic describes how the Type 4 driver determines the value of null
+parameters passed as a parameter value on DatabaseMetaData methods.
+Since other vendors might implement the JDBC specification differently,
+this information explains the Type 4 driver results on the affected
+queries.
+
+This implementation applies to methods that take parameters that can
+represent a pattern. The names of these parameters have the format:
+
+```
+attributePattern
+```
+
+The many methods of the java.sql.DatabaseMetaData class are affected;
+for example, the `getColumns()` method.
+
+For another example, schema is the attribute in the parameter
+`schemaPattern`, which is a parameter to the `java.sql.ResultSet.getAttributes` method.
+
+[source, java]
+----
+public ResultSet getAttributes( String catalog
+ , String schemaPattern
+ , String typeNamePattern
+ , String attributeNamePattern
+ ) throws SQLException
+----
+
+If the application passes a null value, the null is treated as follows:
+
+* If a parameter name contains the suffix Pattern, the null is interpreted as a `%` wild card.
+* If the parameter name does not contain the suffix `Pattern`, nulls are interpreted as the default value for that parameter.
+
+Using this example, null parameters are interpreted as follows:
+
+|===
+| `catalog` | The default catalog name.
+| `schemaPattern` | A `%` wild card retrieves data for all schemas of the specified catalog
+|===
+
+<<<
+[[type-4-driver-conformance-to-sql-data-types]]
+== Type 4 Driver Conformance to SQL Data Types
+
+[[jdbc-data-types]]
+=== JDBC Data Types
+
+The following table shows the JDBC data types that are supported by Type
+4 driver and their corresponding {project-name} SQL data types:
+
+[cols="30%,40%,30%", options="header"]
+|===
+| JDBC Data Type | Support by JDBC Driver for {project-name} SQL | {project-name} SQL Data Type
+| `Types.Array` | No | Not applicable.
+| `Types.BIGINT` | Yes | `LARGEINT`
+| `Types.BINARY` | Data type is mapped by {project-name} SQL. Data type varies from that used for table creation. | `CHAR(n)`^1^
+| `Types.BIT` | Data type is mapped by {project-name} SQL. Data type varies from that used for table creation. | `CHAR(1)`
+| `Types.BLOB` | Yes | `LARGEINT`
+| `Types.CHAR` | Yes | `CHAR(n)`
+| `Types.CLOB` | Yes | `LARGEINT`
+| `Types.DATE` | Yes | `DATE`
+| `Types.DECIMAL` | Yes | `DECIMAL(p,s)`
+| `Types.DISTINCT` | No | Not applicable.
+| `Types.DOUBLE` | Yes | `DOUBLE PRECISION`
+| `Types.FLOAT` | Yes | `FLOAT(p)`
+| `Types.INTEGER` | Yes | `INTEGER`
+| `Types.JAVA_OBJECT` | No | Not applicable.
+| `Types.LONGVARBINARY` | Data type is mapped by {project-name} SQL. Data type varies from that used for table creation. | `VARCHAR(n)`^1^
+| `Types.LONGVARCHAR` | Yes. Maximum length is 4018. | `VARCHAR[(n)]`
+| `Types.NULL` | No | Not applicable.
+| `Types.NUMERIC` | Yes | `NUMERIC(p,s)`
+| `Types.REAL` | Yes | `FLOAT(p)`
+| `Types.REF` | No | Not applicable.
+| `Types.SMALLINT` | Yes | `SMALLINT`
+| `Types.STRUCT` | No | Not applicable.
+| `Types.TIME` | Yes | `TIME`
+| `Types.TIMESTAMP` | Yes | `TIMESTAMP`
+| `Types.TINYINT` | Data type is mapped by {project-name} SQL. Data type varies from that used for table creation. | `SMALLINT`
+| `Types.VARBINARY` | Data type is mapped by {project-name} SQL. Data type varies from that used for table creation. | `VARCHAR(n)`^1^
+| `Types.VARCHAR` | Yes | `VARCHAR(n)`
+| `Types.BOOLEAN` | Data type is mapped by {project-name} SQL. Data type varies from that used for table creation. | `CHAR(1)`
+| `Types.DATALINK` | No | Not applicable.
+|===
+
+^1^ Because of mapping provided by {project-name}, a `ResultSet.getObject()` method returns a string object instead of an array of bytes.
+
+The Type 4 driver maps the following data types to the JDBC data type `Types.OTHER`:
+
+```
+INTERVAL YEAR(p)
+INTERVAL YEAR(p) TO MONTH
+INTERVAL MONTH(p)
+INTERVAL DAY(p)
+INTERVAL DAY(p) TO HOUR
+INTERVAL DAY(p) TO MINUTE
+INTERVAL DAY(p) TO SECOND
+INTERVAL HOUR(p)
+INTERVAL HOUR(p) TO MINUTE
+INTERVAL HOUR(p) TO SECOND
+INTERVAL MINUTE(p)
+INTERVAL MINUTE(p) TO SECOND
+INTERVAL SECOND(p)
+```
+
+[[floating-point-support]]
+== Floating-Point Support
+
+The Type 4 driver supports only IEEE floating-point data to be passed between the application client and the Type 4 driver.
+
+[[sqlj-support]]
+== SQLJ Support
+
+The Type 4 driver supports non-customized SQLJ applications, but does not support customized SQLJ applications.
+
+<<<
+[[jdbc-3-0-features-not-supported-by-the-type-4-driver]]
+== JDBC 3.0 Features Not Supported by the Type 4 Driver
+
+These features are not required for JDBC 3.0 compliance, and they are not supported by the {project-name} JDBC Type 4 driver.
+
+* Multiple result sets returned by batch statements.
+* Database savepoint support. (Not provided in {project-name} SQL )
+* Retrieval of auto generated keys.
+* Transform group and type mapping.
+* Relationship between connector architecture and JDBC 3.0 SPI.
+* Secured socket communication or encryption for the interaction between the Type 4 driver and DCS.
+* Security context (user name and password) implicit propagation from AppServer to the Type 4 driver.
+* IPV6 protocol stack. (IPV6 addressing is emulated over IPV4 on the {project-name} platform - server side)
+* Distributed transactions.
+
+[[restrictions]]
+== Restrictions
+
+* The Type 4 driver supports only database features that are supported by {project-name} SQL and SPJ.
+Therefore, the Type 4 driver is not fully compliant with JDBC 3.0 specifications.
+
+* The Type 4 driver depends on the HP connectivity service for all server side manageability related features.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc
new file mode 100644
index 0000000..a0f8219
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/introduction.adoc
@@ -0,0 +1,53 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[introduction]]
+= Introduction
+
+This document describes how to use the {project-name} JDBC Type 4
+Driver. This driver provides Java applications running on a foreign
+platform with JDBC access to {project-name} SQL databases on the
+{project-name}.
+
+*Supported Java Releases:* The Type 4 driver requires Java enabled
+platforms that support JDK 1.4.1 or higher.
+
+
+[[type-4-driver-api-package]]
+== Type 4 Driver API Package
+
+The Type 4 driver package, `org.trafodion.t4jdbc`, is shipped with the
+driver software. For class and method descriptions, see the
+_{project-name} JDBC Type 4 Driver API Reference_.
+
+The {project-name} JDBC Type 4 Driver (hereafter, Type 4 driver)
+implements JDBC technology that conforms to the standard JDBC 3.0 Data
+Access API.
+
+To obtain detailed information on the standard JDBC API, download the
+JDBC API documentation: http://docs.oracle.com/en/java/.
+
+[[installation]]
+== Installation
+
+Refer to the {docs-url}/client_install/index.html[Trafodion Client Installation Guide].
+
[19/22] incubator-trafodion git commit: Added missing Apache license
text.
Posted by db...@apache.org.
Added missing Apache license text.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/d7d75f68
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/d7d75f68
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/d7d75f68
Branch: refs/heads/master
Commit: d7d75f683bb73c358d03be5d2fb3f0883ea3b600
Parents: 4bc748d
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Mon May 2 11:18:59 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Mon May 2 11:18:59 2016 -0600
----------------------------------------------------------------------
docs/shared/acknowledgements.txt | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/d7d75f68/docs/shared/acknowledgements.txt
----------------------------------------------------------------------
diff --git a/docs/shared/acknowledgements.txt b/docs/shared/acknowledgements.txt
index c395596..75065e8 100644
--- a/docs/shared/acknowledgements.txt
+++ b/docs/shared/acknowledgements.txt
@@ -1,3 +1,25 @@
+\ufeff////
+* @@@ 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 @@@
+////
*Acknowledgements*
Microsoft�, Windows�, Windows NT�, Windows� XP, and Windows Vista� are
[11/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/grant_privileges.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/grant_privileges.adoc b/docs/spj_guide/src/asciidoc/_chapters/grant_privileges.adoc
index f369931..76f3f20 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/grant_privileges.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/grant_privileges.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[grant-privileges]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/introduction.adoc b/docs/spj_guide/src/asciidoc/_chapters/introduction.adoc
index d877409..9881403 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/introduction.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[introduction]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/performance_troubleshooting.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/performance_troubleshooting.adoc b/docs/spj_guide/src/asciidoc/_chapters/performance_troubleshooting.adoc
index ed5b4e0..476995c 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/performance_troubleshooting.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/performance_troubleshooting.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[performance-and-troubleshooting]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/sample_database.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/sample_database.adoc b/docs/spj_guide/src/asciidoc/_chapters/sample_database.adoc
index db1fd42..f79d8f4 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/sample_database.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/sample_database.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[b-sample-database]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc b/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc
index a22f1a1..1667e4c 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/sample_spjs.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[a-sample-spjs]]
@@ -37,7 +37,7 @@ sample name. For example, click on
link:{sourcedir}/Sales.java[Sales.java]
to download the sample sales class source file.
+
-You can access the complete source directory at: http://trafodion.apache.org/docs/spj_guide/resources/source/
+You can access the complete source directory at: {docs-url}/spj_guide/resources/source/
<<<
[[procedures-in-the-sales-schema]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/index.adoc b/docs/spj_guide/src/asciidoc/index.adoc
index 6bc14f9..ee0d7ce 100644
--- a/docs/spj_guide/src/asciidoc/index.adoc
+++ b/docs/spj_guide/src/asciidoc/index.adoc
@@ -45,17 +45,10 @@
include::../../shared/license.txt[]
<<<
-include::resources/acknowledgements.txt[]
+include::../../shared/acknowledgements.txt[]
<<<
-*Revision History*
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 2.0.0 | To be announced.
-| 1.3.0 | January, 2016
-|===
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/resources/acknowledgements.txt
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/resources/acknowledgements.txt b/docs/spj_guide/src/resources/acknowledgements.txt
deleted file mode 100644
index c395596..0000000
--- a/docs/spj_guide/src/resources/acknowledgements.txt
+++ /dev/null
@@ -1,38 +0,0 @@
-*Acknowledgements*
-
-Microsoft�, Windows�, Windows NT�, Windows� XP, and Windows Vista� are
-U.S. registered trademarks of Microsoft Corporation. Intel� and Intel�
-Itanium� are trademarks of Intel Corporation in the U.S. and other
-countries. Java� is a registered trademark of Oracle and/or its
-affiliates. Motif, OSF/1, UNIX�, X/Open�, and the X device is a
-trademark of X/Open Company Ltd. in the UK and other countries.
-
-OSF, OSF/1, OSF/Motif, Motif, and Open Software Foundation are trademarks of
-the Open Software Foundation in the U.S. and other countries.
-� 1990, 1991, 1992, 1993 Open Software Foundation, Inc.
-
-The OSF documentation and the OSF software to which it relates are derived in
-part from materials supplied by the following: � 1987, 1988, 1989
-Carnegie-Mellon University. � 1989, 1990, 1991 Digital Equipment
-Corporation. � 1985, 1988, 1989, 1990 Encore Computer Corporation. � 1988 Free
-Software Foundation, Inc. � 1987, 1988, 1989, 1990, 1991 Hewlett-Packard
-Company. � 1985, 1987, 1988, 1989, 1990, 1991, 1992 International
-Business Machines Corporation. � 1988, 1989 Massachusetts Institute of
-Technology. � 1988, 1989, 1990 Mentat Inc. � 1988 Microsoft Corporation.
-� 1987, 1988, 1989, 1990, 1991,
-1992 SecureWare, Inc. � 1990, 1991 Siemens Nixdorf Informations systeme
-AG. � 1986, 1989, 1996, 1997 Sun Microsystems, Inc. � 1989, 1990, 1991
-Transarc Corporation.
-
-OSF software and documentation are based in part
-on the Fourth Berkeley Software Distribution under license from The
-Regents of the University of California. OSF acknowledges the following
-individuals and institutions for their role in its development: Kenneth
-C.R.C. Arnold, Gregory S. Couch, Conrad C. Huang, Ed James, Symmetric
-Computer Systems, Robert Elz. � 1980, 1981, 1982, 1983, 1985, 1986,
-1987, 1988, 1989 Regents of the University of California. OSF MAKES NO
-WARRANTY OF ANY KIND WITH REGARD TO THE OSF MATERIAL PROVIDED HEREIN,
-INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS FOR A PARTICULAR PURPOSE. OSF shall not be liable for errors
-contained herein or for incidental consequential damages in connection
-with the furnishing, performance, or use of this material.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/pom.xml
----------------------------------------------------------------------
diff --git a/docs/sql_reference/pom.xml b/docs/sql_reference/pom.xml
index 6e91e6b..bb51e5b 100644
--- a/docs/sql_reference/pom.xml
+++ b/docs/sql_reference/pom.xml
@@ -187,6 +187,10 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -205,6 +209,10 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/about.adoc b/docs/sql_reference/src/asciidoc/_chapters/about.adoc
index 0cc63d6..247e70d 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/about.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/about.adoc
@@ -20,18 +20,18 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[About_This_Document]]
= About This Document
This manual describes reference information about the syntax of SQL statements, functions, and other
-SQL language elements supported by the Trafodion project\u2019s database software.
+SQL language elements supported by the {project-name} project\u2019s database software.
-Trafodion SQL statements and utilities are entered interactively or from script files using a client-based tool,
+{project-name} SQL statements and utilities are entered interactively or from script files using a client-based tool,
such as the Trafodion Command Interface (TrafCI). To install and configure a client application that enables you
-to connect to and use a Trafodion database, see the
-http://trafodion.incubator.apache.org/docs/client_install/index.html[_Trafodion Client Installation Guide_].
+to connect to and use a {project-name} database, see the
+{docs-url}/client_install/index.html[_{project-name} Client Installation Guide_].
NOTE: In this manual, SQL language elements, statements, and clauses within statements are based on the
ANSI SQL:1999 standard.
@@ -39,7 +39,7 @@ ANSI SQL:1999 standard.
[[Intended_Audience]]
== Intended Audience
This manual is intended for database administrators and application programmers who are using SQL to read, update,
-and create Trafodion SQL tables, which map to HBase tables, and to access native HBase and Hive tables.
+and create {project-name} SQL tables, which map to HBase tables, and to access native HBase and Hive tables.
You should be familiar with structured query language (SQL) and with the American National Standard Database Language SQL:1999.
@@ -74,20 +74,20 @@ command through an SQL interface | <<get_hbase_objects_st
[cols="50%,50%",options="header"]
|===
|Chapter or Appendix | Description
-| <<Introduction,Introduction>> | Introduces Trafodion SQL and covers topics such as data consistency,
+| <<Introduction,Introduction>> | Introduces {project-name} SQL and covers topics such as data consistency,
transaction management, and ANSI compliance.
-| <<SQL_Statements,SQL Statements>> | Describes the SQL statements supported by Trafodion SQL.
-| <<SQL_Utilities,SQL Utilities>> | Describes the SQL utilities supported by Trafodion SQL.
+| <<SQL_Statements,SQL Statements>> | Describes the SQL statements supported by {project-name} SQL.
+| <<SQL_Utilities,SQL Utilities>> | Describes the SQL utilities supported by {project-name} SQL.
| <<SQL_Language Elements,SQL Language Elements>> | Describes parts of the language, such as database objects, data types,
-expressions, identifiers, literals, and predicates, which occur within the syntax of Trafodion SQL statements.
-| <<SQL_Clauses,SQL Clauses>> | Describes clauses used by Trafodion SQL statements.
+expressions, identifiers, literals, and predicates, which occur within the syntax of {project-name} SQL statements.
+| <<SQL_Clauses,SQL Clauses>> | Describes clauses used by {project-name} SQL statements.
| <<SQL_Functions_and_Expressions,SQL Functions and Expressions>> | Describes specific functions and expressions that you can use in
-Trafodion SQL statements.
+{project-name} SQL statements.
| <<SQL_Runtime_Statistics,SQL Runtime Statistics>> | Describes how to gather statistics for active queries or for the Runtime
Management System (RMS) and describes the RMS counters that are returned.
| <<OLAP_Functions,OLAP Functions>> | Describes specific on line analytical processing functions.
-| <<Reserved_Words,Appendix A: Reserved Words>> | Lists the words that are reserved in Trafodion SQL.
-| <<Limits,Appendix B: Limits>> | Describes limits in Trafodion SQL.
+| <<Reserved_Words,Appendix A: Reserved Words>> | Lists the words that are reserved in {project-name} SQL.
+| <<Limits,Appendix B: Limits>> | Describes limits in {project-name} SQL.
|===
@@ -218,24 +218,8 @@ match-value [NOT] LIKE _pattern
```
<<<
-== Publishing History
-[cols="2*",options="header"]
-|===
-| Product Version | Publication Date
-| Trafodion Release 1.3.0 | January 2016
-| Trafodion Release 1.1.0 | April 2015
-| Trafodion Release 1.0.0 | January 2015
-| Trafodion Release 0.9.0 Beta | October 2014
-| Trafodion Release 0.8.1 Beta | August 2014
-| Trafodion Release 0.8.0 Beta | June 2014
-|===
-
== 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:
-
-issues@trafodion.incubator.apache.org
+We encourage 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 {project-support}.
Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
-Or, even better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/introduction.adoc b/docs/sql_reference/src/asciidoc/_chapters/introduction.adoc
index 2badda6..b22f498 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/introduction.adoc
@@ -20,25 +20,25 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[introduction]]
= Introduction
-The Trafodion SQL database software allows you to use SQL statements, which comply closely to
-ANSI SQL:1999, to access data in Trafodion SQL tables, which map to HBase tables, and to access
+The {project-name} SQL database software allows you to use SQL statements, which comply closely to
+ANSI SQL:1999, to access data in {project-name} SQL tables, which map to HBase tables, and to access
native HBase tables and Hive tables.
This introduction describes:
* <<sql_language,SQL Language>>
-* <<using_trafodion_sql_to_access_hbase_tables,Using Trafodion SQL to Access HBase Tables>>
-* <<using_trafodion_sql_to_access_hive_tables,Using Trafodion SQL to Access Hive Tables>>
+* <<using_trafodion_sql_to_access_hbase_tables,Using {project-name} SQL to Access HBase Tables>>
+* <<using_trafodion_sql_to_access_hive_tables,Using {project-name} SQL to Access Hive Tables>>
* <<data_consistency_and_access_options,Data Consistency and Access Options>>
* <<transaction_management,Transaction Management>>
-* <<ansi_compliance_and_trafodion_sql_extensions,ANSI Compliance and Trafodion SQL Extensions>>
-* <<trafodion_sql_error_messages,Trafodion SQL Error Messages>>
+* <<ansi_compliance_and_trafodion_sql_extensions,ANSI Compliance and {project-name} SQL Extensions>>
+* <<trafodion_sql_error_messages,{project-name} SQL Error Messages>>
Other sections of this manual describe the syntax and semantics of individual statements, commands, and language elements.
@@ -62,36 +62,36 @@ For information on specific functions and expressions, see:
<<<
[[using_trafodion_sql_to_access_hbase_tables]]
-== Using Trafodion SQL to Access HBase Tables
+== Using {project-name} SQL to Access HBase Tables
-You can use Trafodion SQL statements to read, update, and create HBase tables.
+You can use {project-name} SQL statements to read, update, and create HBase tables.
-* <<initializing_the_trafodion_metadata,Initializing the Trafodion Metadata>>
+* <<initializing_the_trafodion_metadata,Initializing the {project-name} Metadata>>
* <<ways_to_access_hbase_tables,Ways to Access HBase Tables>>
-* <<trafodion_sql_tables_versus_native_hbase_tables,Trafodion SQL Tables Versus Native HBase Tables>>
+* <<trafodion_sql_tables_versus_native_hbase_tables,{project-name} SQL Tables Versus Native HBase Tables>>
* <<supported_sql_statements_with_hbase_tables,Supported SQL Statements With HBase Tables>>
For a list of Control Query Default (CQD) settings for the HBase environment, see the
-http://trafodion.incubator.apache.org/docs/cqd_reference/index.hmtl[Trafodion Control Query Default (CQD) Reference Guide].
+{docs-url}/cqd_reference/index.hmtl[{project-name} Control Query Default (CQD) Reference Guide].
[[ways_to_access_hbase_tables]]
=== Ways to Access HBase Tables
-Trafodion SQL supports these ways to access HBase tables:
+{project-name} SQL supports these ways to access HBase tables:
-* <<accessing_trafodion_sql_tables,Accessing Trafodion SQL Tables>>
+* <<accessing_trafodion_sql_tables,Accessing {project-name} SQL Tables>>
* <<cell_per_row_access_to_hbase_tables,Cell-Per-Row Access to HBase Tables (Technology Preview)>>
* <<rowwise_access_to_hbase_tables,Rowwise Access to HBase Tables (Technology Preview)>>
<<<
[[accessing_trafodion_sql_tables]]
-==== Accessing Trafodion SQL Tables
+==== Accessing {project-name} SQL Tables
-A Trafodion SQL table is a relational SQL table generated by a `CREATE TABLE` statement and mapped
-to an HBase table. Trafodion SQL tables have regular ANSI names in the catalog `TRAFODION`.
-A Trafodion SQL table name can be a fully qualified ANSI name of the form
+A {project-name} SQL table is a relational SQL table generated by a `CREATE TABLE` statement and mapped
+to an HBase table. {project-name} SQL tables have regular ANSI names in the catalog `TRAFODION`.
+A {project-name} SQL table name can be a fully qualified ANSI name of the form
`TRAFODION._schema-name.object-name_`.
-To access a Trafodion SQL table, specify its ANSI table name in a Trafodion SQL statement, similar
+To access a {project-name} SQL table, specify its ANSI table name in a {project-name} SQL statement, similar
to how you would specify an ANSI table name when running SQL statements in a relational database.
*Example*
@@ -112,8 +112,8 @@ SET SCHEMA trafodion.sales;
SELECT * FROM odetail;
```
-For more information about Trafodion SQL tables, see
-<<trafodion_sql_tables_versus_native_hbase_tables,Trafodion SQL Tables Versus Native HBase Tables>>.
+For more information about {project-name} SQL tables, see
+<<trafodion_sql_tables_versus_native_hbase_tables,{project-name} SQL Tables Versus Native HBase Tables>>.
<<<
[[cell_per_row_access_to_hbase_tables]]
@@ -124,7 +124,7 @@ complete but has not been tested or debugged.
To access HBase data using cell-per-row mode, specify the schema `HBASE."_CELL_"` and the full ANSI
name of the table as a delimited table name. You can specify the name of any HBase table, regardless of whether
-it was created through Trafodion SQL.
+it was created through {project-name} SQL.
*Example*
@@ -158,7 +158,7 @@ complete but has not been tested or debugged.
To access HBase data using rowwise mode, specify the schema `HBASE."_ROW_"` and the full ANSI name of the
table as a delimited table name. You can specify the name of any HBase table, regardless of whether
-it was created through Trafodion SQL.
+it was created through {project-name} SQL.
*Example*
@@ -182,9 +182,9 @@ PRIMARY KEY (ROW_ID)
<<<
[[trafodion_sql_tables_versus_native_hbase_tables]]
-=== Trafodion SQL Tables Versus Native HBase Tables
+=== {project-name} SQL Tables Versus Native HBase Tables
-Trafodion SQL tables have many advantages over regular HBase tables:
+{project-name} SQL tables have many advantages over regular HBase tables:
* They can be made to look like regular, structured SQL tables with fixed columns.
* They support the usual SQL data types supported in relational databases.
@@ -194,7 +194,7 @@ Trafodion SQL tables have many advantages over regular HBase tables:
key prefix to avoid hot spots for sequential keys. For the syntax,
see the <<create_table_statement,CREATE TABLE Statement>>.
-The problem with Trafodion SQL tables is that they use a fixed format to represent column values,
+The problem with {project-name} SQL tables is that they use a fixed format to represent column values,
making it harder for native HBase applications to access them. Also, they have a fixed structure,
so users lose the flexibility of dynamic columns that comes with HBase.
@@ -216,24 +216,24 @@ You can use these SQL statements with HBase tables:
<<<
[[using_trafodion_sql_to_access_hive_tables]]
-== Using Trafodion SQL to Access Hive Tables
+== Using {project-name} SQL to Access Hive Tables
-You can use Trafodion SQL statements to access Hive tables.
+You can use {project-name} SQL statements to access Hive tables.
* <<ansi_names_for_hive_tables,ANSI Names for Hive Tables>>
-* <<type_mapping_from_hive_to_trafodion_sql,Type Mapping From Hive to Trafodion SQL>>
+* <<type_mapping_from_hive_to_trafodion_sql,Type Mapping From Hive to {project-name} SQL>>
* <<supported_sql_statements_with_hive_tables,Supported SQL Statements With Hive Tables>>
For a list of Control Query Default (CQD) settings for the Hive environment, see the
-http://trafodion.incubator.apache.org/docs/cqd_reference/index.hmtl[Trafodion Control Query Default (CQD) Reference Guide].
+{docs-url}/cqd_reference/index.hmtl[{project-name} Control Query Default (CQD) Reference Guide].
[[ansi_names_for_hive_tables]]
=== ANSI Names for Hive Tables
-Hive tables appear in the Trafodion Hive ANSI name space in a special catalog and schema named `HIVE.HIVE`.
+Hive tables appear in the {project-name} Hive ANSI name space in a special catalog and schema named `HIVE.HIVE`.
To select from a Hive table named `T`, specify an implicit or explicit name, such as `HIVE.HIVE.T`,
-in a Trafodion SQL statement.
+in a {project-name} SQL statement.
*Example*
This example should work if a Hive table named `T` has already been defined:
@@ -252,13 +252,13 @@ select * from hive.hive.t; -- explicit table name
<<<
[[type_mapping_from_hive_to_trafodion_sql]]
-=== Type Mapping From Hive to Trafodion SQL
+=== Type Mapping From Hive to {project-name} SQL
-Trafodion performs the following data-type mappings:
+{project-name} performs the following data-type mappings:
[cols="2*",options="header"]
|===
-| Hive Type | Trafodion SQL Type
+| Hive Type | {project-name} SQL Type
| `tinyint` | `smallint`
| `smallint` | `smallint`
| `int` | `int`
@@ -270,8 +270,8 @@ Trafodion performs the following data-type mappings:
|===
1. The value `_n_` is determined by `CQD HIVE_MAX_STRING_LENGTH`. See the
-http://trafodion.incubator.apache.org/docs/cqd_reference/index.hmtl[Trafodion Control Query Default (CQD) Reference Guide].
-2. Hive supports timestamps with nanosecond resolution (precision of 9). Trafodion SQL supports only microsecond resolution (precision 6).
+{docs-url}/cqd_reference/index.hmtl[{project-name} Control Query Default (CQD) Reference Guide].
+2. Hive supports timestamps with nanosecond resolution (precision of 9). {project-name} SQL supports only microsecond resolution (precision 6).
[[supported_sql_statements_with_hive_tables]]
=== Supported SQL Statements With Hive Tables
@@ -354,15 +354,15 @@ Transactions you define are called _user-defined transactions_. To be sure that
successfully or not at all, you can define one transaction consisting of these statements by using the BEGIN WORK
statement and COMMIT WORK statement. You can abort a transaction by using the ROLLBACK WORK statement.
-If AUTOCOMMIT is on, then you do not have to end the transaction explicitly as Trafodion SQL will end the transaction
-automatically. Sometimes an error occurs that requires the user-defined transaction to be aborted. Trafodion SQL
+If AUTOCOMMIT is on, then you do not have to end the transaction explicitly as {project-name} SQL will end the transaction
+automatically. Sometimes an error occurs that requires the user-defined transaction to be aborted. {project-name} SQL
will automatically abort the transaction and return an error indicating that the transaction was rolled back.
<<<
[[system_defined_transactions]]
==== System-Defined Transactions
-In some cases, Trafodion SQL defines transactions for you. These transactions are called _system-defined transactions_.
+In some cases, {project-name} SQL defines transactions for you. These transactions are called _system-defined transactions_.
Most DML statements initiate transactions implicitly at the start of execution.
See <<implicit_transactions,Implicit Transactions>>.
@@ -377,11 +377,11 @@ If deadlock occurs, the DML statement times out and receives an error.
[[effect_of_autocommit_option]]
=== Effect of AUTOCOMMIT Option
-AUTOCOMMIT is an option that can be set in a SET TRANSACTION statement. It specifies whether Trafodion SQL will commit
+AUTOCOMMIT is an option that can be set in a SET TRANSACTION statement. It specifies whether {project-name} SQL will commit
automatically, or roll back if an error occurs, at the end of statement execution. This option applies to any statement
for which the system initiates a transaction. See <<set_transaction_statement,SET TRANSACTION Statement>>.
-If this option is set to ON, Trafodion SQL automatically commits any changes, or rolls back any changes, made to the
+If this option is set to ON, {project-name} SQL automatically commits any changes, or rolls back any changes, made to the
database at the end of statement execution.
[[concurrency]]
@@ -392,7 +392,7 @@ available — whether a process that requests access to data that is already
in a wait queue — depends on the purpose of the access mode (read or update) and the isolation level. Currently, the only
isolation level is READ COMMITTED.
-Trafodion SQL provides concurrent database access for most operations and controls database access through concurrency
+{project-name} SQL provides concurrent database access for most operations and controls database access through concurrency
control and the mechanism for opening and closing tables. For DML operations, the access option affects the degree of
concurrency. See <<data_consistency_and_access_options,Data Consistency and Access Options>>.
@@ -417,17 +417,17 @@ The default isolation level is READ COMMITTED.
<<<
[[ansi_compliance_and_trafodion_sql_extensions]]
-== ANSI Compliance and Trafodion SQL Extensions
+== ANSI Compliance and {project-name} SQL Extensions
-Trafodion SQL complies most closely with Core SQL 99. Trafodion SQL also includes some features from SQL 99 and part of
-the SQL 2003 standard, and special Trafodion SQL extensions to the SQL language.
+{project-name} SQL complies most closely with Core SQL 99. {project-name} SQL also includes some features from SQL 99 and part of
+the SQL 2003 standard, and special {project-name} SQL extensions to the SQL language.
-Statements and SQL elements in this manual are ANSI compliant unless specified as Trafodion SQL extensions.
+Statements and SQL elements in this manual are ANSI compliant unless specified as {project-name} SQL extensions.
[[ansi_compliant_statements]]
=== ANSI-Compliant Statements
-These statements are ANSI compliant, but some might contain Trafodion SQL extensions:
+These statements are ANSI compliant, but some might contain {project-name} SQL extensions:
|===
| <<alter_table_statement,ALTER TABLE Statement>> | <<call_statement,CALL Statement>>
@@ -450,9 +450,9 @@ These statements are ANSI compliant, but some might contain Trafodion SQL extens
<<<
[[statements_that_are_trafodion_sql_extensions]]
-=== Statements That Are Trafodion SQL Extensions
+=== Statements That Are {project-name} SQL Extensions
-These statements are Trafodion SQL extensions to the ANSI standard.
+These statements are {project-name} SQL extensions to the ANSI standard.
|===
| <<alter_library_statement,ALTER LIBRARY Statement>> | <<alter_user_statement,ALTER USER Statement>>
@@ -475,7 +475,7 @@ These statements are Trafodion SQL extensions to the ANSI standard.
[[ansi_compliant_functions]]
=== ANSI-Compliant Functions
-These functions are ANSI compliant, but some might contain Trafodion SQL extensions:
+These functions are ANSI compliant, but some might contain {project-name} SQL extensions:
|===
| <<avg,AVG function>> | <<case, CASE expression>>
@@ -492,16 +492,16 @@ These functions are ANSI compliant, but some might contain Trafodion SQL extensi
| <<upper,UPPER>>
|===
-All other functions are Trafodion SQL extensions.
+All other functions are {project-name} SQL extensions.
-== Trafodion SQL Error Messages
+== {project-name} SQL Error Messages
-Trafodion SQL reports error messages and exception conditions. When an error condition occurs,
-Trafodion SQL returns a message number and a brief description of the condition.
+{project-name} SQL reports error messages and exception conditions. When an error condition occurs,
+{project-name} SQL returns a message number and a brief description of the condition.
*Example*
-Trafodion SQL might display this error message:
+{project-name} SQL might display this error message:
```
*** ERROR[1000] A syntax error occurred.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/limits.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/limits.adoc b/docs/sql_reference/src/asciidoc/_chapters/limits.adoc
index 27af6d0..5bbe2f4 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/limits.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/limits.adoc
@@ -20,13 +20,13 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[limits]]
= Limits
-This section lists limits for various parts of Trafodion SQL.
+This section lists limits for various parts of {project-name} SQL.
[cols="30%h,70%"]
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/olap_functions.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/olap_functions.adoc b/docs/sql_reference/src/asciidoc/_chapters/olap_functions.adoc
index e01b45b..8923214 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/olap_functions.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/olap_functions.adoc
@@ -20,19 +20,18 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
-<<<
[[olap_functions]]
-=== OLAP Functions
+= OLAP Functions
This section describes the syntax and semantics of the On Line
Analytical Process (OLAP) window functions. The OLAP window functions
are ANSI compliant.
[[considerations_for_window_functions]]
-=== Considerations for Window Functions
+== Considerations for Window Functions
These considerations apply to all window functions.
@@ -63,7 +62,7 @@ CURRENT ROW".
"ROWS _preceding-row_" is equivalent to "ROWS BETWEEN _preceding-row_
AND CURRENT ROW".
-==== Nulls
+=== Nulls
All nulls are eliminated before the function is applied to the set of
values. If the window contains all NULL values, the result of the window
@@ -136,7 +135,7 @@ GROUP BY num, workgroupnum, annualsalary;
These limitations apply to all window functions.
-* The ANSI _window-clause_ is not supported by Trafodion. Only the
+* The ANSI _window-clause_ is not supported by {project-name}. Only the
_inline-window-specification_ is supported. An attempt to use an ANSI
_window-clause_ will result in a syntax error.
@@ -149,10 +148,10 @@ term, either explicitly or implicitly will result in the "4343" error
message.
* The window frame units can only be ROWS. RANGE is not supported by
-Trafodion. An attempt to use RANGE will result in a syntax error.
+{project-name}. An attempt to use RANGE will result in a syntax error.
* The ANSI _window-frame-exclusion-specification_ is not supported by
-Trafodion. An attempt to use a _window-frame-exclusion-specification_
+{project-name}. An attempt to use a _window-frame-exclusion-specification_
will result in a syntax error.
* Multiple _inline-window-specifications_ in a single SELECT clause are
@@ -163,13 +162,13 @@ _inline-window-specifications_ in a single SELECT clause will result in
the "4340" error message.
* The ANSI _null-ordering-specification_ within the ORDER BY clause is
-not supported by Trafodion. Null values will always be sorted as if they
+not supported by {project-name}. Null values will always be sorted as if they
are greater than all non-null values. This is slightly different than a
null ordering of NULLS LAST. An attempt to use a
_null-ordering-specification_ will result in a syntax error.
* The ANSI _filter-clause_ is not supported for window functions by
-Trafodion. The _filter-clause_ applies to all aggregate functions
+{project-name}. The _filter-clause_ applies to all aggregate functions
(grouped and windowed) and that the _filter-clause_ is not currently
supported for grouped aggregate functions. An attempt to use a
_filter-clause_ will result in a syntax error.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/reserved_words.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/reserved_words.adoc b/docs/sql_reference/src/asciidoc/_chapters/reserved_words.adoc
index 478a2e5..0362601 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/reserved_words.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/reserved_words.adoc
@@ -20,23 +20,22 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
-<<<
[[reserved_words]]
= Reserved Words
-The words listed in this appendix are reserved for use by Trafodion SQL.
+The words listed in this appendix are reserved for use by {project-name} SQL.
To prevent syntax errors, avoid using these words as identifiers in
-Trafodion SQL. In Trafodion SQL, if an operating system name contains a
+{project-name} SQL. In {project-name} SQL, if an operating system name contains a
reserved word, you must enclose the reserved word in double quotes (")
to access that column or object.
-NOTE: In Trafodion SQL, ABSOLUTE, DATA, EVERY, INITIALIZE, OPERATION,
+NOTE: In {project-name} SQL, ABSOLUTE, DATA, EVERY, INITIALIZE, OPERATION,
PATH, SPACE, STATE, STATEMENT, STATIC, and START are not reserved words.
-Trafodion SQL treats these words as reserved when they are part of
-Trafodion SQL stored text. They cannot be used as identifiers unless you
+{project-name} SQL treats these words as reserved when they are part of
+{project-name} SQL stored text. They cannot be used as identifiers unless you
enclose them in double quotes.
[[reserved_sql_identifiers_a]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/runtime_stats.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/runtime_stats.adoc b/docs/sql_reference/src/asciidoc/_chapters/runtime_stats.adoc
index 56dc11d..6f1e17d 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/runtime_stats.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/runtime_stats.adoc
@@ -20,15 +20,14 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
-<<<
[[sql_runtime_statistics]]
= SQL Runtime Statistics
The Runtime Management System (RMS) shows the status of queries while
-they are running. RMS can service on-demand requests from the Trafodion
+they are running. RMS can service on-demand requests from the {project-name}
Command Interface (TrafCI) to get statistics for a given query ID or for
active queries in a given process. RMS also provides information about
itself to determine the health of the RMS infrastructure.
@@ -1089,7 +1088,7 @@ provided for each node.
[cols="30%l,70%",options="header"]
|===
| Counter | Description
-| CPU | The node number of the Trafodion cluster.
+| CPU | The node number of the {project-name} cluster.
| RMS Version | Internal version of RMS.
| SSCP PID | SQL Statistics control process ID.
| SSCP Creation Timestamp | Actual timestamp when SQL statistics control process was created.
@@ -1102,7 +1101,7 @@ provided for each node.
| No. of Process Regd. | Number of processes registered in the shared segment.
| No. of Query Fragments Regd. | Number of query fragments registered in the shared segment.
| RMS Semaphore Owner | Process ID that locked the semaphore at this instance of time.
-| No. of SSCPs Opened | Number of Statistics Control Processes opened. Normally, this should be equal to the number of nodes in the Trafodion cluster.
+| No. of SSCPs Opened | Number of Statistics Control Processes opened. Normally, this should be equal to the number of nodes in the {project-name} cluster.
| No. of SSCPs Open Deleted | Number of Statistics Control Processes with broken communication. Usually, this should be 0.
| Last GC Time | The recent timestamp at which the shared segment was garbage collected.
| Queries GCed in Last Run | Number of queries that were garbage collected in the recent GC run.
@@ -1184,8 +1183,8 @@ these parts of the query ID:
[cols="30%l,70%",options="header"]
|===
| Attribute Value | Description
-| SEGMENTNUM | Logical node ID in Trafodion cluster
-| CPUNUM or CPU | Logical node ID in Trafodion cluster
+| SEGMENTNUM | Logical node ID in {project-name} cluster
+| CPUNUM or CPU | Logical node ID in {project-name} cluster
| PIN | Linux process ID number
| EXESTARTTIME | Executor start time
| SESSIONNUM | Session number
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/sql_clauses.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/sql_clauses.adoc b/docs/sql_reference/src/asciidoc/_chapters/sql_clauses.adoc
index 7ae2973..dbe39a3 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/sql_clauses.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/sql_clauses.adoc
@@ -20,13 +20,13 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[sql_clauses]]
= SQL Clauses
-Clauses are used by Trafodion SQL statements to specify default values,
+Clauses are used by {project-name} SQL statements to specify default values,
ways to sample or sort data, how to store physical data, and other
details.
@@ -318,7 +318,7 @@ statement. The intermediate result table consists of the rows returned
by a WHERE clause or, if no WHERE clause exists, the FROM clause. See
<<select_statement,SELECT Statement>>.
-SAMPLE is a Trafodion SQL extension.
+SAMPLE is a {project-name} SQL extension.
```
SAMPLE sampling-methodis:
@@ -346,7 +346,7 @@ rows-size is:
* `RANDOM _percent-size_`
+
-directs Trafodion SQL to choose rows randomly (each row having an
+directs {project-name} SQL to choose rows randomly (each row having an
unbiased probability of being chosen) without replacement from the
result table. The sampling size is determined by the _percent-size_,
defined as:
@@ -366,7 +366,7 @@ Therefore, the actual size of the resulting sample is approximately _r_% of _N_.
The number of rows picked follows a binomial distribution with
mean equal to _r_ *c_N_/100.
+
-If you specify a sample size greater than 100 PERCENT, Trafodion SQL
+If you specify a sample size greater than 100 PERCENT, {project-name} SQL
returns all the rows in the result table plus duplicate rows. The
duplicate rows are picked from the result table according to the
specified sampling method. This technique is called oversampling.
@@ -377,7 +377,7 @@ specifies row sampling. Row sampling is the default.
** `BALANCE`
+
-If you specify a BALANCE expression, Trafodion SQL performs stratified
+If you specify a BALANCE expression, {project-name} SQL performs stratified
sampling. The intermediate result table is divided into disjoint strata
based on the WHEN conditions.
+
@@ -389,8 +389,8 @@ no true condition exists, the row belongs to the ELSE stratum.
* `FIRST _rows-size_ [SORT BY _colname_ [ASC[ENDING] | DESC[ENDING]]
[,_colname_ [ASC[ENDING] | DESC[ENDING]]]…]`
+
-directs Trafodion SQL to choose the first rows from the result table.
-You can specify the order of the rows to sample. Otherwise, Trafodion
+directs {project-name} SQL to choose the first rows from the result table.
+You can specify the order of the rows to sample. Otherwise, {project-name}
SQL chooses an arbitrary order. The sampling size is determined by the
_rows-size_, defined as:
@@ -410,13 +410,13 @@ is the minimum of _s_ and _N_.
[ASC[ENDING] | DESC[ENDING]] [,_colname_ [ASC[ENDING] |
DESC[ENDING]]]…]`
+
-directs Trafodion SQL to choose the first rows from each block (or
+directs {project-name} SQL to choose the first rows from each block (or
period) of contiguous rows. This sampling method is equivalent to a
separate FIRST sampling for each period, and the _rows-size_ is defined
as in FIRST sampling.
+
The size of the period is specified as a number of rows. You can specify
-the order of the rows to sample. Otherwise, Trafodion SQL chooses an
+the order of the rows to sample. Otherwise, {project-name} SQL chooses an
arbitrary order.
+
<<<
@@ -786,7 +786,7 @@ of the intermediate result table for calculating sequence functions.
This option is used for processing time-sequenced rows in data mining
applications. See <<select_statement>>.
-Sequence by is a Trafodion SQL extension.
+Sequence by is a {project-name} SQL extension.
```
SEQUENCE BY colname[ASC[ENDING]|DESC[ENDING]]
@@ -807,7 +807,7 @@ considered equal to one another but greater than all other non-null
values.
+
You must include a SEQUENCE BY clause if you include a sequence function
-in the select list of the SELECT statement. Otherwise, Trafodion SQL
+in the select list of the SELECT statement. Otherwise, {project-name} SQL
returns an error. Further, you cannot include a SEQUENCE BY clause if no
sequence function exists in the select list. See
<<sequence_functions,Sequence Functions>> .
@@ -1001,7 +1001,7 @@ The result table of the TRANSPOSE clause has all the columns of the
source table plus, for each transpose item list, a value column or
columns and an optional key column.
-TRANSPOSE is a Trafodion SQL extension.
+TRANSPOSE is a {project-name} SQL extension.
```
TRANSPOSE transpose-set [transpose-set]...
[17/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
Prepared documents for TLP and centralized shared information.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/21d6d8d3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/21d6d8d3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/21d6d8d3
Branch: refs/heads/master
Commit: 21d6d8d36fdb21854acdd6737e597034b76552f9
Parents: 716b92e
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Sun May 1 23:58:28 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Sun May 1 23:58:28 2016 -0600
----------------------------------------------------------------------
docs/client_install/pom.xml | 10 +
.../src/asciidoc/_chapters/SQuirrel.adoc | 16 +-
.../src/asciidoc/_chapters/about.adoc | 16 +-
.../src/asciidoc/_chapters/dbviz.adoc | 12 +-
.../src/asciidoc/_chapters/introduction.adoc | 104 +++---
.../src/asciidoc/_chapters/jdbct4.adoc | 32 +-
.../src/asciidoc/_chapters/odb.adoc | 8 +-
.../src/asciidoc/_chapters/odbc_linux.adoc | 18 +-
.../src/asciidoc/_chapters/odbc_windows.adoc | 54 +--
.../src/asciidoc/_chapters/trafci.adoc | 10 +-
docs/client_install/src/asciidoc/index.adoc | 28 +-
docs/command_interface/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 22 +-
.../src/asciidoc/_chapters/commands.adoc | 40 +-
.../src/asciidoc/_chapters/install.adoc | 4 +-
.../src/asciidoc/_chapters/interactive.adoc | 14 +-
.../src/asciidoc/_chapters/introduction.adoc | 6 +-
.../src/asciidoc/_chapters/launch.adoc | 16 +-
.../src/asciidoc/_chapters/perlpython.adoc | 6 +-
.../src/asciidoc/_chapters/scripts.adoc | 4 +-
docs/command_interface/src/asciidoc/index.adoc | 29 +-
docs/cqd_reference/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 23 +-
.../src/asciidoc/_chapters/debugging.adoc | 14 +-
.../src/asciidoc/_chapters/histograms.adoc | 16 +-
.../src/asciidoc/_chapters/introduction.adoc | 8 +-
.../_chapters/operational_controls.adoc | 26 +-
.../src/asciidoc/_chapters/query_execution.adoc | 46 +--
.../src/asciidoc/_chapters/query_plans.adoc | 78 ++--
.../asciidoc/_chapters/runtime_controls.adoc | 6 +-
.../src/asciidoc/_chapters/schema_controls.adoc | 8 +-
.../asciidoc/_chapters/table_definition.adoc | 28 +-
.../src/asciidoc/_chapters/transactions.adoc | 6 +-
.../src/asciidoc/_chapters/update_stats.adoc | 14 +-
docs/cqd_reference/src/asciidoc/index.adoc | 21 +-
docs/jdbct4ref_guide/src/asciidoc/index.adoc | 11 +-
.../src/resources/acknowledgements.txt | 38 --
docs/load_transform/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 31 +-
.../src/asciidoc/_chapters/bulk_load.adoc | 34 +-
.../src/asciidoc/_chapters/bulk_unload.adoc | 12 +-
.../src/asciidoc/_chapters/introduction.adoc | 24 +-
.../src/asciidoc/_chapters/monitor.adoc | 8 +-
.../src/asciidoc/_chapters/tables_indexes.adoc | 24 +-
.../src/asciidoc/_chapters/trickle_load.adoc | 54 +--
.../src/asciidoc/_chapters/troubleshoot.adoc | 20 +-
docs/load_transform/src/asciidoc/index.adoc | 22 +-
docs/messages_guide/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 25 +-
.../src/asciidoc/_chapters/binder_msgs.adoc | 162 ++++----
.../src/asciidoc/_chapters/compiler_msgs.adoc | 164 ++++----
.../src/asciidoc/_chapters/ddl_msgs.adoc | 156 ++++----
.../src/asciidoc/_chapters/executor_msgs.adoc | 82 ++--
.../asciidoc/_chapters/file_system_errors.adoc | 6 +-
.../src/asciidoc/_chapters/generator_msgs.adoc | 4 +-
.../src/asciidoc/_chapters/introduction.adoc | 34 +-
.../src/asciidoc/_chapters/optimizer_msgs.adoc | 6 +-
.../src/asciidoc/_chapters/parser_msgs.adoc | 74 ++--
.../src/asciidoc/_chapters/sort_msgs.adoc | 68 ++--
.../src/asciidoc/_chapters/sqlstate.adoc | 78 ++--
.../_chapters/udr_language_mgr_msgs.adoc | 26 +-
docs/messages_guide/src/asciidoc/index.adoc | 21 +-
docs/odb_user/pom.xml | 8 +
.../src/asciidoc/_chapters/a_warnings.adoc | 4 +-
docs/odb_user/src/asciidoc/_chapters/about.adoc | 24 +-
.../src/asciidoc/_chapters/b_develop.adoc | 2 +-
.../src/asciidoc/_chapters/compare_tables.adoc | 2 +-
.../src/asciidoc/_chapters/concepts.adoc | 10 +-
.../src/asciidoc/_chapters/install.adoc | Bin 13598 -> 13534 bytes
.../src/asciidoc/_chapters/introduction.adoc | 36 +-
docs/odb_user/src/asciidoc/_chapters/load.adoc | 12 +-
.../src/asciidoc/_chapters/query_driver.adoc | 4 +-
.../src/asciidoc/_chapters/sql_interpreter.adoc | 4 +-
docs/odb_user/src/asciidoc/index.adoc | 21 +-
docs/provisioning_guide/pom.xml | 10 +
.../src/asciidoc/_chapters/about.adoc | 35 +-
.../src/asciidoc/_chapters/activate.adoc | 30 +-
.../src/asciidoc/_chapters/enable_security.adoc | 52 +--
.../src/asciidoc/_chapters/introduction.adoc | 184 ++++-----
.../src/asciidoc/_chapters/prepare.adoc | 84 ++---
.../src/asciidoc/_chapters/requirements.adoc | 124 +++---
.../src/asciidoc/_chapters/script_install.adoc | 80 ++--
.../src/asciidoc/_chapters/script_remove.adoc | 22 +-
.../src/asciidoc/_chapters/script_upgrade.adoc | 82 ++--
docs/provisioning_guide/src/asciidoc/index.adoc | 22 +-
docs/shared/acknowledgements.txt | 38 ++
docs/shared/revisions.txt | 32 ++
.../spj_guide/src/asciidoc/_chapters/about.adoc | 2 +-
.../src/asciidoc/_chapters/create_spjs.adoc | 36 +-
.../src/asciidoc/_chapters/deploy_spjs.adoc | 34 +-
.../src/asciidoc/_chapters/develop_spjs.adoc | 36 +-
.../src/asciidoc/_chapters/execute_spjs.adoc | 34 +-
.../src/asciidoc/_chapters/get_started.adoc | 36 +-
.../asciidoc/_chapters/grant_privileges.adoc | 36 +-
.../src/asciidoc/_chapters/introduction.adoc | 36 +-
.../_chapters/performance_troubleshooting.adoc | 36 +-
.../src/asciidoc/_chapters/sample_database.adoc | 36 +-
.../src/asciidoc/_chapters/sample_spjs.adoc | 38 +-
docs/spj_guide/src/asciidoc/index.adoc | 11 +-
.../src/resources/acknowledgements.txt | 38 --
docs/sql_reference/pom.xml | 8 +
.../src/asciidoc/_chapters/about.adoc | 48 +--
.../src/asciidoc/_chapters/introduction.adoc | 112 +++---
.../src/asciidoc/_chapters/limits.adoc | 4 +-
.../src/asciidoc/_chapters/olap_functions.adoc | 19 +-
.../src/asciidoc/_chapters/reserved_words.adoc | 13 +-
.../src/asciidoc/_chapters/runtime_stats.adoc | 13 +-
.../src/asciidoc/_chapters/sql_clauses.adoc | 26 +-
.../sql_functions_and_expressions.adoc | 304 +++++++--------
.../_chapters/sql_language_elements.adoc | 160 ++++----
.../src/asciidoc/_chapters/sql_statements.adoc | 374 +++++++++----------
.../src/asciidoc/_chapters/sql_utilities.adoc | 84 ++---
docs/sql_reference/src/asciidoc/index.adoc | 27 +-
113 files changed, 2172 insertions(+), 2310 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/pom.xml
----------------------------------------------------------------------
diff --git a/docs/client_install/pom.xml b/docs/client_install/pom.xml
index 0deba63..fe19517 100644
--- a/docs/client_install/pom.xml
+++ b/docs/client_install/pom.xml
@@ -184,6 +184,11 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
+ <download-url>http://http://trafodion.incubator.apache.org/download.html</download-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -209,6 +214,11 @@
<idprefix/>
<idseparator>-</idseparator>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
+ <download-url>http://http://trafodion.incubator.apache.org/download.html</download-url>
<build-date>${maven.build.timestamp}</build-date>
</attributes>
</configuration>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc b/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc
index 3c3315f..563993f 100644
--- a/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc
@@ -21,39 +21,39 @@
////
= Configure SQuirreL Client
-These configuration instructions apply to Trafodion Release 1.3.*_n_* and subsequent updates of Trafodion until otherwise indicated.
+These configuration instructions apply to {project-name} Release 1.3.*_n_* and subsequent updates of {project-name} until otherwise indicated.
== Prerequisite Software
Make sure that you have this software installed on your workstation:
* Java Runtime Environment (JRE) 1.7 or higher. See <<jdbct4-java-environment, Java Environment>> in the <<jdbct4, Install JDBC Type-4 Driver>> chapter above.
-* Trafodion JDBC Type-4 Driver. See <<jdbct4,Install JDBC Type-4 Driver>> above.
+* {project-name} JDBC Type-4 Driver. See <<jdbct4,Install JDBC Type-4 Driver>> above.
* SQuirreL SQL Client 3.5.0. See the http://squirrel-sql.sourceforge.net/[_SQuirreL SQL Client website_].
<<<
== Configuration Instructions
=== Register JDBC Type-4 Driver
-Use the *Add Driver* function and register the Trafodion JDBC Type-4 Driver:
+Use the *Add Driver* function and register the {project-name} JDBC Type-4 Driver:
-1. Click on the *Add* button and locate the Trafodion JDBC Type-4 Driver.
+1. Click on the *Add* button and locate the {project-name} JDBC Type-4 Driver.
2. Click on the *List Drivers* button to find the JDBC Driver Class Name.
3. Set the properties as shown below:
+
image:{images}/Add_Driver_SQuirreL.jpg[alt="SQuirreL Add Driver Dialog Box"]
+
-* Name: `Trafodion`
+* Name: `{project-name}`
* Example URL: `jdbc:t4jdbc://_host-name or ip-address_:37800/:` (Default port number: *23400*)
<<<
-=== Connect to Trafodion
+=== Connect to {project-name}
-Use the Add Alias dialog box and create an alias for your Trafodion System:
+Use the Add Alias dialog box and create an alias for your {project-name} System:
image:{images}/Add_Alias_SQuirreL.jpg[alt="SQuirreL Add Alias Dialog Box"]
-1. Edit the connection *URL* to match your Trafodion system's host name and port number:
+1. Edit the connection *URL* to match your {project-name} system's host name and port number:
+
*Example*
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/about.adoc b/docs/client_install/src/asciidoc/_chapters/about.adoc
index 1f42ab3..25e220c 100644
--- a/docs/client_install/src/asciidoc/_chapters/about.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/about.adoc
@@ -20,17 +20,17 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
-This manual describes how to install and configure client applications that enable you to connect to and use a Trafodion database.
+This manual describes how to install and configure client applications that enable you to connect to and use a {project-name} database.
== Intended Audience
-This manual is intended for users who want to connect to and use a Trafodion database.
+This manual is intended for users who want to connect to and use a {project-name} database.
== New and Changed Information
-This manual shows updated versions for Trafodion Release {project-version}. It also provides instructions on how to download and install <<odb,Trafodion odb>>, a
+This manual shows updated versions for {project-name} Release {project-version}. It also provides instructions on how to download and install <<odb,{project-name} odb>>, a
new multi-threaded, ODBC-based command-line tool for parallel data loading and extracting.
== Notation Conventions
@@ -160,11 +160,7 @@ match-value [NOT] LIKE _pattern
```
== 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:
-
-issues@trafodion.incubator.apache.org
+We encourage 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 {project-support}.
Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
-Or, even better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/_chapters/dbviz.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/dbviz.adoc b/docs/client_install/src/asciidoc/_chapters/dbviz.adoc
index b355cfb..d064e2a 100644
--- a/docs/client_install/src/asciidoc/_chapters/dbviz.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/dbviz.adoc
@@ -30,7 +30,7 @@ Make sure that you have this software installed on your workstation:
+
In addition, see DbVisualizer\u2019s FAQ \u201cHow to\u201d page:
http://confluence.dbvis.com/pages/viewpage.action?pageId=3146120[_How do I change the Java version that DbVisualizer uses?_]
-* Trafodion JDBC Type-4 Driver. See <<jdbct4,Install JDBC Type-4 Driver>> above.
+* {project-name} JDBC Type-4 Driver. See <<jdbct4,Install JDBC Type-4 Driver>> above.
* DbVisualizer 9.x.x. See the http://www.dbvis.com/[_DbVisualizer website_].
== Configuration Instructions
@@ -58,11 +58,11 @@ image:{images}/Physical_Connection.jpg[width=600,height=600,alt="DbVisualizer Ph
<<<
=== Register JDBC Type-4 Driver
-Use the DbVisualizer Driver Manager and register the Trafodion JDBC Type-4 Driver.
+Use the DbVisualizer Driver Manager and register the {project-name} JDBC Type-4 Driver.
image:{images}/DbVisualizer_Driver_Manager.jpg[image]
-* Use the Open File icon and locate the Trafodion JDBC Type-4 Driver.
+* Use the Open File icon and locate the {project-name} JDBC Type-4 Driver.
* Use the JDBC URL format:
+
```
@@ -72,10 +72,10 @@ jdbc:t4jdbc://<host-name or ip-address>:23400/:
*NOTE*: This example uses a modified port number (*37800*) rather than the default port number (*23400*).
<<<
-=== Connect to Trafodion
+=== Connect to {project-name}
-Create a new connection by selecting the Trafodion JDBC Type-4 Driver and filling in the connection parameters. Edit the database URL to match
-your Trafodion system\u2019s host name and port number; for example: `jdbc:t4jdbc://<host-name or ip-address>:37800/:` (default is: *23400*).
+Create a new connection by selecting the {project-name} JDBC Type-4 Driver and filling in the connection parameters. Edit the database URL to match
+your {project-name} system\u2019s host name and port number; for example: `jdbc:t4jdbc://<host-name or ip-address>:37800/:` (default is: *23400*).
image:{images}/Database_Connection_in_DbVisualizer.jpg[image]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 91485b7..8e9f06d 100644
--- a/docs/client_install/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/introduction.adoc
@@ -1,101 +1,101 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[introduction]]
= Introduction
-This manual describes how to install and configure the following client applications, which enable you to connect to and use a Trafodion
+This manual describes how to install and configure the following client applications, which enable you to connect to and use a {project-name}
database.
== Client Summary
=== JDBC-Based Clients
-The following table lists JDBC-based clients supported by Trafodion.
+The following table lists JDBC-based clients supported by {project-name}.
[cols="30%,70%",options="header"]
|===
| Client Name | Description
-| *Trafodion JDBC Type 4 Driver* | A driver that enables Java applications that run on a client workstation to connect to a Trafodion database. +
+| *{project-name} JDBC Type 4 Driver* | A driver that enables Java applications that run on a client workstation to connect to a {project-name} database. +
+
-*NOTE:* The Trafodion Command Interface (TrafCI), DbVisualizer, and SQuirreL SQL Client require this driver to be installed on the client
+*NOTE:* The {project-name} 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/docs/command_interface/index.html[Trafodion Command Interface 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
+| *{project-name} Command Interface (TrafCI)* | A command-line interface that allows you to connect to a {project-name} database and run SQL statements and other commands interactively or from
+script files. For more information, see the http://trafodion.incubator.apache.org/docs/command_interface/index.html[{project-name} Command Interface Guide].
+| *DbVisualizer* | A third-party database tool that allows you to connect to a {project-name} 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 {project-name} database. For more information, see the
http://squirrel-sql.sourceforge.net/[SQuirreL SQL Client website].
|===
=== ODBC-Based Clients
-The following table lists ODBC-based clients supported by Trafodion.
+The following table lists ODBC-based clients supported by {project-name}.
[cols="30%,70%",options="header"]
|===
| Client Name | Description
-| *Trafodion ODBC Driver for Linux* | A driver that enables applications, which were developed for the Microsoft ODBC API and run on a Linux workstation, to connect to a
-Trafodion database.
-| *Trafodion ODBC Driver for Windows* | *[Not included in this release]*^1^ +
+| *{project-name} ODBC Driver for Linux* | A driver that enables applications, which were developed for the Microsoft ODBC API and run on a Linux workstation, to connect to a
+{project-name} database.
+| *{project-name} ODBC Driver for Windows* | *[Not included in this release]*^1^ +
+
A driver that enables applications, which were developed for the Microsoft Open Database Connectivity (ODBC) application programming
-interface (API) and which run on a Windows workstation, to connect to a Trafodion database.
-| *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/docs/odb/index.html[Trafodion odb User Guide].
+interface (API) and which run on a Windows workstation, to connect to a {project-name} database.
+| *{project-name} odb tool* | A multi-threaded, ODBC-based command-line tool for parallel data loading and extracting. For more information, see the
+{docs-url}/odb/index.html[{project-name} odb User Guide].
|===
-^1^ License issues prevent us from including the ODBC Driver for Windows in this release. Contact the
-Trafodion user e-mail list (user@trafodion.incubator.apache.org) for help obtaining the driver.
+^1^ License issues prevent us from including the ODBC Driver for Windows in this release. Contact
+{project-support} for help obtaining the driver.
<<<
[[introduction-download]]
== Download Installation Package
-The Trafodion client software is available from the http://http://trafodion.apache.org/download.html[Trafodion Download] page. There is one
-`Trafodion Clients` package per release listed under *<version> Binaries*.
+The {project-name} client software is available from the {download-url}[{project-name} Download] page. There is one
+`{project-name} Clients` package per release listed under *<version> Binaries*.
-The `Trafodion Clients` package consists of a zipped tar file that contains the Trafodion Clients tar file. The Trafodion Client
+The `{project-name} Clients` package consists of a zipped tar file that contains the {project-name} Clients tar file. The {project-name} Client
binaries are located in the Clients folder, which contains the following files:
[cols="30%l,70%", options="header"]
|===
| File | Usage
-| odbc64_linux.tar.gz | Trafodion odb tool.
-| TFODBC64-*.exe | *[Not included in this release]*^1^ Trafodion ODBC Driver for Windows.
-| TRAF_ODBC_Linux_Driver_64.tar.gz | Trafodion ODBC driver for Linux.
-| trafci.zip | The Trafodion command interpreter `trafci`.
-| JDBCT4.zip | Trafodion JDBC Type 4 Driver.
+| odbc64_linux.tar.gz | {project-name} odb tool.
+| TFODBC64-*.exe | *[Not included in this release]*^1^ {project-name} ODBC Driver for Windows.
+| TRAF_ODBC_Linux_Driver_64.tar.gz | {project-name} ODBC driver for Linux.
+| trafci.zip | The {project-name} command interpreter `trafci`.
+| JDBCT4.zip | {project-name} JDBC Type 4 Driver.
|===
-^1^ License issues prevent us from including the ODBC Driver for Windows in this release. Contact the
-Trafodion user e-mail list (user@trafodion.incubator.apache.org) for help obtaining the driver.
+^1^ License issues prevent us from including the ODBC Driver for Windows in this release. Contact
+{project-support} for help obtaining the driver.
[[introduction-windows-download]]
=== Windows Download
Do the following:
-1. Create a download folder on the client workstation. For example, `Trafodion Downloads`.
+1. Create a download folder on the client workstation. For example, `{project-name} Downloads`.
-2. Open a Web browser and navigate to the Trafodion downloads site http://trafodion.incubator.apache.org/download.html.
+2. Open a Web browser and navigate to the {project-name} downloads site {download-url}.
3. Orient yourself to the binaries for the release you're installing.
-Click on the `Trafodion Clients` link to start downloading the Trafodion clients tar file to your workstation.
+Click on the `{project-name} Clients` link to start downloading the {project-name} clients tar file to your workstation.
4. Place the `apache-trafodion-clients-*.tar.gz` file into the download folder.
@@ -109,7 +109,7 @@ the `clients` folder, which has the following content:
JDBCT4.zip odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz
```
+
-You use these files to install the different Trafodion clients.
+You use these files to install the different {project-name} clients.
[[introduction-linux-download]]
=== Linux Download
@@ -118,10 +118,10 @@ Do the following:
1. Create a download directory on the client workstation. For example, `$HOME/trafodion-downloads`.
-2. Open a Web browser and navigate to the Trafodion downloads site http://trafodion.incubator.apache.org/download.html.
+2. Open a Web browser and navigate to the {project-name} downloads site {download-url}.
3. Orient yourself to the binaries for the release you're installing.
-Right-click on the `Trafodion Clients` link and select *Copy link address*.
+Right-click on the `{project-name} Clients` link and select *Copy link address*.
4. Go to the download directory on the client workstation and use `wget` to download the client package
using the link address you copied in step 3 above.
@@ -141,7 +141,7 @@ JDBCT4.zip odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz
$
```
+
-You use these files to install the different Trafodion clients.
+You use these files to install the different {project-name} clients.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc b/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc
index 74b68c2..e6261ca 100644
--- a/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc
@@ -26,12 +26,12 @@
[[jdbct4-installation-requirements]]
== Installation Requirements
-The Trafodion JDBC Type 4 Driver requires a Java-enabled platform that supports the Java Development Kit (JDK) 1.7 or higher.
+The {project-name} JDBC Type 4 Driver requires a Java-enabled platform that supports the Java Development Kit (JDK) 1.7 or higher.
[[jdbct4-java-environment]]
=== Java Environment
-The Trafodion JDBC Type 4 Driver requires that a compatible Java version be installed on the client workstation and that the Java path be set to
+The {project-name} JDBC Type 4 Driver requires that a compatible Java version be installed on the client workstation and that the Java path be set to
the correct location. The supported Java version is 1.7 or higher.
NOTE: If you plan to do Java-based development, install the Java Development Kit (JDK) rather than the Java Runtime Environment (JRE).
@@ -166,7 +166,7 @@ use the setenv command instead of export.
[[jdbct4-install-instructions]]
== Installation Instructions
-You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above.
+You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above.
[[jdbct4-install-driver]]
=== Install JDBC Type-4 Driver
@@ -204,7 +204,7 @@ The content of the target directory is as follows:
=== Java Development
-If you plan to write and run Java applications that use the Trafodion JDBC Type 4 Driver to connect to a Trafodion database, then set these
+If you plan to write and run Java applications that use the {project-name} JDBC Type 4 Driver to connect to a {project-name} database, then set these
environment variables on the client workstation, replacing `_jdk-directory_` with the location of your Java Development Kit and
replacing `_jdbc-installation-directory_` with the name of the directory where you downloaded the JDBC Type 4 driver:
@@ -232,13 +232,13 @@ Set these values for your environment:
* _url_: Specify this string: _jdbc:t4jdbc://_host-name_:_port-number_/:_
_host-name_ is the IP address or host name of the database platform, and _port-number_ is the location where the
-Trafodion Database Connectivity Service (DCS) is running, which is *23400* by default. See the
-http://trafodion.incubator.apache.org/docs/dcs_reference/index.html[Trafodion Database Connectivity Services Reference Guide]
+{project-name} Database Connectivity Service (DCS) is running, which is *23400* by default. See the
+http://trafodion.incubator.apache.org/docs/dcs_reference/index.html[{project-name} Database Connectivity Services Reference Guide]
for information about how to configure the DCS port.
*Example*
-In this example, Trafodion authentication has not been enabled. Therefore, you can use a dummy
+In this example, {project-name} authentication has not been enabled. Therefore, you can use a dummy
user and password. If authentication is enabled, then use your user and password information.
```
@@ -257,22 +257,22 @@ NOTE: The driver\u2019s class name is `org.trafodion.jdbc.t4.T4Driver`.
== Test Programs
The `README` file in the `samples` folder provide information for how you build and run sample Java programs.
-You can use these programs to verify the setup of the Trafodion JDBC Type-4 driver.
+You can use these programs to verify the setup of the {project-name} JDBC Type-4 driver.
See the <<jdbct4-install-driver, Install JDBC Type-4 Driver>> section above for information on the different
-sample programs that are included with the Trafodion JDBC Type-4 driver.
+sample programs that are included with the {project-name} JDBC Type-4 driver.
*Example*
Build and run the StatementSample test program to verify the JDBC Type-4 driver installation.
```
-C:\Development Tools\Trafodion JDBCT4\samples>cd StatementSample
+C:\Development Tools\{project-name} JDBCT4\samples>cd StatementSample
-C:\Development Tools\Trafodion JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\javac -classpath ..\..\lib\jdbcT4.jar *.java ..\common\*.java
+C:\Development Tools\{project-name} JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\javac -classpath ..\..\lib\jdbcT4.jar *.java ..\common\*.java
Note: ..\common\sampleUtils.java uses or overrides a deprecated API.
Note: Recompile with -Xlint:deprecation for details.
v
-C:\Development Tools\Trafodion JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\java -classpath ..\..\lib\jdbcT4.jar;..;. -Dt4jdbc.properties=..\t4jdbc.properties StatementSample
+C:\Development Tools\{project-name} JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\java -classpath ..\..\lib\jdbcT4.jar;..;. -Dt4jdbc.properties=..\t4jdbc.properties StatementSample
Mar 16, 2016 9:36:54 PM common.sampleUtils getPropertiesConnection
INFO: DriverManager.getConnection(url, props) passed
@@ -341,12 +341,12 @@ Column 12 - -100.12,-100.12
End of Data
-C:\Development Tools\Trafodion JDBCT4\samples\StatementSample>
+C:\Development Tools\{project-name} JDBCT4\samples\StatementSample>
```
<<<
== Uninstall JDBC Type-4 Driver
-Run one of these sets of commands to remove the Trafodion JDBC Type 4 Driver:
+Run one of these sets of commands to remove the {project-name} JDBC Type 4 Driver:
* On Linux:
+
@@ -408,7 +408,7 @@ C:\>
== Reinstall JDBC Type-4 Driver
1. Close all applications running on the workstation, except the Web browser.
-2. Download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above.
-3. Install the new Trafodion JDBC Type-4 driver. See <<jdbct4-install-driver, Install JDBC Type-4 Driver>>.
+2. Download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above.
+3. Install the new {project-name} JDBC Type-4 driver. See <<jdbct4-install-driver, Install JDBC Type-4 Driver>>.
4. Set up the client environment. Please refer to: <<jdbct4-setup-env, Set Up Client Environment>>.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/_chapters/odb.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/odb.adoc b/docs/client_install/src/asciidoc/_chapters/odb.adoc
index ff8745d..512a0ea 100644
--- a/docs/client_install/src/asciidoc/_chapters/odb.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/odb.adoc
@@ -28,15 +28,15 @@
The odb tool runs on 64-bit Linux. On a Linux workstation, odb requires `pthread` libraries, which are usually installed by default. It also
requires the unixODBC Driver Manager to be installed and configured on the client workstation. For more information, see the
-http://trafodion.apache.org/docs/odb/index.html[_Trafodion odb User Guide_].
+{docs-url}/odb/index.html[_{project-name} odb User Guide_].
[[installation-instructions]]
== Installation Instructions
NOTE: Before following these installation instructions, please make sure to install and configure unixODBC on the client workstation. For more
-information, see the http://trafodion.apache.org/docs/odb/index.html[_Trafodion odb User Guide_].
+information, see the {docs-url}/odb/index.html[_{project-name} odb User Guide_].
-You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above.
+You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above.
[[odb-install]]
=== Install odb
@@ -54,7 +54,7 @@ The command extracts these files:
* `README`
* `/bin/odb64luo` (the odb executable)
-3. You are now ready to run the odb executable. For more information, see the http://trafodion.apache.org/docs/odb/index.html[_Trafodion odb User Guide_].
+3. You are now ready to run the odb executable. For more information, see the {docs-url}/odb/index.html[_{project-name} odb User Guide_].
[[odb-uninstall]]
== Uninstall odb
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc b/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc
index e0419e3..6838df8 100644
--- a/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc
@@ -30,9 +30,9 @@ If you are building ODBC applications, please use the preferred build platform,
== Installation Instructions
-You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above.
+You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above.
-The package file contains the Trafodion ODBC distribution file, `TRAF_ODBC_Linux_Driver_64.tar.gz`, which is extracted to the `clients` subdirectory.
+The package file contains the {project-name} ODBC distribution file, `TRAF_ODBC_Linux_Driver_64.tar.gz`, which is extracted to the `clients` subdirectory.
It contains the following files:
```
@@ -48,13 +48,13 @@ MD5SUM
TRAFDSN
```
-By default, a new version of the Trafodion ODBC driver is installed in the following directories unless you specify a different directory
+By default, a new version of the {project-name} ODBC driver is installed in the following directories unless you specify a different directory
during installation:
* `/usr/lib64`
* `/etc/odbc`
-NOTE: The following header files are not packaged with the Trafodion ODBC driver: +
+NOTE: The following header files are not packaged with the {project-name} ODBC driver: +
+
- `sql.h` +
- `sqlext.h` +
@@ -65,7 +65,7 @@ To install those header files, <<win_odbc_client_env, Setting Up the Client Envi
=== Install/Reinstall Linux ODBC Driver
-NOTE: You must have root access to install the Trafodion ODBC Driver for Linux at the default system location.
+NOTE: You must have root access to install the {project-name} ODBC Driver for Linux at the default system location.
1. Change the directory to the clients subdirectory, and decompress the `.tar.gz` distribution file:
+
@@ -124,11 +124,11 @@ The `yum` command automatically installs the header files in the `/usr/include`
=== Enable Compression
When compression is enabled in the ODBC driver, the ODBC driver can send and receive large volumes of data quickly and efficiently to and from
-the Trafodion Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled.
+the {project-name} Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled.
To enable compression in the ODBC driver or to change the compression setting, follow these steps:
-* If you are using the Trafodion ODBC driver manager, add
+* If you are using the {project-name} ODBC driver manager, add
+
```
Compression = compression-level
@@ -171,7 +171,7 @@ to `odbc.ini`).
NOTE: The examples after each step assume that you have default installation directories.
-If you have a previous version of the Trafodion ODBC driver installed, you need to re-link your existing application to ensure that you pick up
+If you have a previous version of the {project-name} ODBC driver installed, you need to re-link your existing application to ensure that you pick up
the correct version of the driver. If you are unsure of the version, check the version of your application with this command:
```
@@ -241,7 +241,7 @@ Connect Test Passed...
NOTE: The Basic SQL sample program is not currently bundled with the ODBC Linux driver. To obtain the source code for this program, see
<<odbc_sample_program, `basicsql` (Sample ODBC Program)>>.
-If you have a previous version of the Trafodion ODBC driver installed, you need to re-link your existing application to ensure that you pick up
+If you have a previous version of the {project-name} ODBC driver installed, you need to re-link your existing application to ensure that you pick up
the correct version of the driver. If you are unsure of the version, check the version of your application with this command:
```
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc b/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc
index 98995b9..1ed67a3 100644
--- a/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc
@@ -24,7 +24,7 @@
= Install Windows ODBC Driver
WARNING: License issues prevent us from including the ODBC Driver for Windows in this release. Contact the
-Trafodion user e-mail list (user@trafodion.incubator.apache.org) for help obtaining the driver.
+{project-name} user e-mail list ({project-support}) for help obtaining the driver.
== Installation Requirements
@@ -45,7 +45,7 @@ Trafodion user e-mail list (user@trafodion.incubator.apache.org) for help obtain
NOTE: To install the driver on your PC, you must be logged on with a user ID that has administrator privileges.
-You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above.
+You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above.
The ODBC client installation file, `TFODBC64-*.exe`, which installs or links to multiple client components:
@@ -54,7 +54,7 @@ The ODBC client installation file, `TFODBC64-*.exe`, which installs or links to
| This client component… | Does this…
| Microsoft ODBC Driver Manager | Manages access to ODBC drivers for applications. The driver manager loads and unloads drivers and passes calls for ODBC functions to the
correct driver.
-| Trafodion ODBC driver | Implements ODBC function calls to enable an ODBC client application to access the Trafodion database.
+| {project-name} ODBC driver | Implements ODBC function calls to enable an ODBC client application to access the {project-name} database.
| Microsoft ODBC Administrator | Adds, configures, and removes ODBC data sources on client workstations.
|===
@@ -64,11 +64,11 @@ during installation:
[cols="40%l,60%",options="header"]
|===
| Default Installation Directory | Client Operating System
-| C:\Program Files\Trafodion\TRAF | ODBC _version_ Windows 64-bit
+| C:\Program Files\{project-name}\TRAF | ODBC _version_ Windows 64-bit
|===
=== Start the InstallShield wizard
-The InstallShield wizard walks you through the steps to install the client components (Trafodion ODBC 1.0) on your workstation. You can
+The InstallShield wizard walks you through the steps to install the client components ({project-name} ODBC 1.0) on your workstation. You can
perform the installation in _interactive mode_, in which you provide input or accept defaults when prompted as ODBC is installed.
Please refer to <<win_odbc_interactive_mode,Interactive Mode Installation>> below.
@@ -78,7 +78,7 @@ Please refer to <<win_odbc_interactive_mode,Interactive Mode Installation>> belo
1. Double-click the `TFODBC64-*.exe` distribution file to start the InstallShield wizard.
2. On the *Welcome* page, click *Next*.
3. Read and select the *I accept the agreement* radio button. Click *Next*.
-4. On the *Destination Folder* page, click *Install* to select the default location: `C:\Program Files\Trafodion\TRAF ODBC _version_\`
+4. On the *Destination Folder* page, click *Install* to select the default location: `C:\Program Files\{project-name}\TRAF ODBC _version_\`
+
This location is the installation directory for ODBC header and help files. All other ODBC files are installed in `%SYSTEMROOT%\system32`.
@@ -88,12 +88,12 @@ This location is the installation directory for ODBC header and help files. All
=== Add a client data source
1. Start the Microsoft ODBC Administrator:
-* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator*
-* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator.
+* On Windows 7: *Start>All Programs>{project-name} ODBC _version_>MS ODBC Administrator*
+* On Windows 8: Right-click the *{project-name} ODBC _version_* icon on the desktop and select MS ODBC Administrator.
* On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item.
2. In the *ODBC Data Source Administrator* dialog box, click *Add*.
-3. Select *TRAF ODBC _version_*, and then click *Finish* to start the *Create a New Trafodion ODBC Data Source* wizard.
+3. Select *TRAF ODBC _version_*, and then click *Finish* to start the *Create a New {project-name} ODBC Data Source* wizard.
4. Enter the data source name (for example, `Default_DataSource_Schema1`) and an optional description, and click *Next*.
5. Enter the `IP address` or `host name` for the database platform. Enter the default port number as *23400*^1^. Leave the defaults as is, and click *Next*.
6. Enter the schema name. The default schema name is `SEABASE`. Click *Next*.
@@ -110,7 +110,7 @@ Click *Finish*.
The wizard attempts to connect to the data source and displays a message stating whether it was successful or not.
10. Click *OK* to save the data source, or click *Cancel* _twice_ to quit the *Create Data Source* wizard.
-^1^ Your specific installation may use a different port number. Check with your Trafodion administrator.
+^1^ Your specific installation may use a different port number. Check with your {project-name} administrator.
<<<
[[win_odbc_client_env]]
@@ -130,8 +130,8 @@ definitions with different schemas on the workstation. The client data source wi
To create a data source on the client workstation, follow these steps:
1. Launch the *MS ODBC Administrator*.
-* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator*
-* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator.
+* On Windows 7: *Start>All Programs>{project-name} ODBC _version_>MS ODBC Administrator*
+* On Windows 8: Right-click the *{project-name} ODBC _version_* icon on the desktop and select MS ODBC Administrator.
* On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item.
2. In the *ODBC Data Source Administrator* dialog box, select the *User DSN* tab, and click *Add*.
@@ -139,7 +139,7 @@ To create a data source on the client workstation, follow these steps:
+
A new dialog box appears, prompting you to create a new data source.
4. Enter the name of the data source, `Default_DataSource`, and click *Next* to continue.
-5. Enter the IP address and port number of the Trafodion system to which will be connecting. By default, the port number is *23400*^1^.
+5. Enter the IP address and port number of the {project-name} system to which will be connecting. By default, the port number is *23400*^1^.
Click *Next* to continue.
6. Select the default schema. If you do not select a schema, the default is `SEABASE`. Click *Next* to continue.
+
@@ -147,25 +147,25 @@ Click *Next* to continue.
7. If desired, configure the *translate dll*, which translates data from one character set to another, and configure the localization. By
default, the client error message language is English, and the client\u2019s local character set is used. Click *Finish* to continue.
+
-The *Test Trafodion ODBC Connection* dialog box appears, allowing you to test the connection using the data source that you created.
+The *Test {project-name} ODBC Connection* dialog box appears, allowing you to test the connection using the data source that you created.
8. Click *Test Connection*.
9. When prompted, enter your user name and password, and, optionally, schema. Click *OK*.
+
-If the connection is successful, you will see `Connected Successfully` in the *Test Trafodion ODBC Connection* dialog box.
+If the connection is successful, you will see `Connected Successfully` in the *Test {project-name} ODBC Connection* dialog box.
10. Click *OK* to save the data source, or click *Cancel* _twice_ to quit the *Create Data Source* wizard.
-^1^ Your specific installation may use a different port number. Check with your Trafodion administrator.
+^1^ Your specific installation may use a different port number. Check with your {project-name} administrator.
=== Enable Compression
When compression is enabled in the ODBC driver, the ODBC driver can send and receive large volumes of data quickly and efficiently to and from
-the Trafodion Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled.
+the {project-name} Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled.
To enable compression in the ODBC driver or to change the compression setting, follow these steps:
1. Launch the MS ODBC Administrator.
-* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator*
-* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator.
+* On Windows 7: *Start>All Programs>{project-name} ODBC _version_>MS ODBC Administrator*
+* On Windows 8: Right-click the *{project-name} ODBC _version_* icon on the desktop and select MS ODBC Administrator.
* On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item.
2. In the *ODBC Data Source Administrator* dialog box, select the *User DSN* tab, select the name of your data source under
@@ -198,7 +198,7 @@ To build and run the executable file, follow these steps:
*Start>All Programs>Microsoft Visual Studio 2010>Visual Studio Tools>Visual Studio x64 Win64 Command Prompt*.
2. At the command prompt, move to the directory where you put the `basicsql.cpp` and build files.
3. Run build at the command prompt. You will see `basicsql.exe` created in the same directory as the source file.
-4. Before running the sample program, create a Trafodion data source named `Default_DataSource` on the client workstation using MS ODBC
+4. Before running the sample program, create a {project-name} data source named `Default_DataSource` on the client workstation using MS ODBC
Administrator. For instructions, please refer to <<win_odbc_client_env,Set Up Client Environment>>.
5. From the command prompt, run the sample program by entering either run or this command:
+
@@ -226,19 +226,19 @@ Basic SQL ODBC Test Passed!
<<<
== Reinstall Windows ODBC Driver
To reinstall the driver, we recommend that you fully remove your ODBC driver and then install the new version. Please refer to
-<<win_odbc_uninstall,Uninstalling the Trafodion ODBC Driver for Windows>> and then <<win_odbc_install, Installing the Trafodion ODBC Driver for Windows>>.
+<<win_odbc_uninstall,Uninstalling the {project-name} ODBC Driver for Windows>> and then <<win_odbc_install, Installing the {project-name} ODBC Driver for Windows>>.
[[win_odbc_uninstall]]
== Uninstalling Windows ODBC Driver
1. Start to remove the ODBC driver:
-* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>Remove TRAF ODBC _version_*
-* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select *Remove TRAF ODBC _version_*.
-* On Windows 10: Right-click the Windows icon in the menu bar. Select *Control Panel*. Click on *Uninstall a program*. Locate *Trafodion ODBC64 _version_* and select it. Click on *Uninstall*.
+* On Windows 7: *Start>All Programs>{project-name} ODBC _version_>Remove TRAF ODBC _version_*
+* On Windows 8: Right-click the *{project-name} ODBC _version_* icon on the desktop and select *Remove TRAF ODBC _version_*.
+* On Windows 10: Right-click the Windows icon in the menu bar. Select *Control Panel*. Click on *Uninstall a program*. Locate *{project-name} ODBC64 _version_* and select it. Click on *Uninstall*.
2. When the *Windows Installer* dialog box asks you if you want to uninstall this product, click *Yes*.
-3. The *Trafodion ODBC _version_* dialog box displays the status and asks you to wait while `Windows configures Trafodion ODBC _version_` (that is, removes
-the Trafodion ODBC Driver from your Windows workstation).
+3. The *{project-name} ODBC _version_* dialog box displays the status and asks you to wait while `Windows configures {project-name} ODBC _version_` (that is, removes
+the {project-name} ODBC Driver from your Windows workstation).
+
-After this dialog box disappears, Trafodion ODBC _version_ is no longer on your workstation.
+After this dialog box disappears, {project-name} ODBC _version_ is no longer on your workstation.
NOTE: Uninstalling the ODBC driver does not remove pre-existing data source definitions from the Windows registry.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/_chapters/trafci.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/trafci.adoc b/docs/client_install/src/asciidoc/_chapters/trafci.adoc
index 2a21d2a..3ab5f7a 100644
--- a/docs/client_install/src/asciidoc/_chapters/trafci.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/trafci.adoc
@@ -49,7 +49,7 @@ Jython open source extensions. To download them manually, see the `README` in th
[[trafci-installation-instructions]]
== Installation Instructions
-You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above.
+You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above.
1. Change the directory to the `clients` subdirectory.
@@ -124,7 +124,7 @@ where you will install trafci.
image:{images}/InstallerWizardPaths.jpg[trafci select path dialog]
3. To locate the JDBC driver JAR file, click *Browse* next to the *JDBC Type 4 Driver JAR File*.
-4. In the *Select JDBC Type 4 Driver JAR File* dialog box, navigate to and select the lib folder of the Trafodion JDBC driver, and then click *Open*.
+4. In the *Select JDBC Type 4 Driver JAR File* dialog box, navigate to and select the lib folder of the {project-name} JDBC driver, and then click *Open*.
5. Select `jdbcT4.jar` so that it appears in the *File Name* box, and then click *Select*.
+
The Installer Wizard now displays the path of the JDBC driver JAR file.
@@ -349,9 +349,9 @@ After downloading and running the installer file, verify that the trafci softwar
| bin | trafci |
| | trafci.cmd | Windows launch file.
| | trafci.pl | Perl wrapper script. _trafci-perl.pl_ is renamed _trafci.pl_. To run this script, see the
-http://trafodion.incubator.apache.com/docs/command_interface/index.html[_Trafodion Command Interface Guide_].
+{docs-url}/command_interface/index.html[_Trafodion Command Interface Guide_].
| | trafci.py | Python wrapper script. trafci-python.py is renamed as trafci.py. To run this script, see the
-http://trafodion.incubator.apache.com/docs/command_interface/index.html[_Trafodion Command Interface Guide_].
+{docs-url}/command_interface/index.html[_Trafodion Command Interface Guide_].
| | trafci.sh | Linux launch file.
| | trafci-perl.pl | Perl wrapper script. This script has been modified to invoke trafci.pl. This script is retained for backward compatibility.
| | trafci-python.py | Python wrapper script. This script has been modified to invoke trafci.py. This script is retained for backward compatibility.
@@ -384,7 +384,7 @@ momentarily in the trafci window before the trafci window disappears:
```
For information about setting up and using trafci, such as choosing the look and feel of the interface or presetting launch parameters, see the
-http://trafodion.incubator.apache.com/docs/command_interface/index.html[Trafodion Command Interface Guide].
+{docs-url}/command_interface/index.html[Trafodion Command Interface Guide].
<<<
=== Windows Example
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/index.adoc b/docs/client_install/src/asciidoc/index.adoc
index 9dc187f..f8ae3b8 100644
--- a/docs/client_install/src/asciidoc/index.adoc
+++ b/docs/client_install/src/asciidoc/index.adoc
@@ -32,7 +32,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
:images: ../images
:sourcedir: ../../resources/source
@@ -43,29 +44,14 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-**License Statement**
+include::../../shared/license.txt[]
-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.
+include::../../shared/acknowledgements.txt[]
-**Acknowledgements**
-
-Microsoft(R) and Windows� are U.S. registered trademarks of Microsoft Corporation. Java� is a registered trademark of Oracle and/or its affiliates. DbVisualizer\u2122 is a trademark of DbVis Software AB.
-
-*Revision History*
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 2.0.0 | To be announced.
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/pom.xml
----------------------------------------------------------------------
diff --git a/docs/command_interface/pom.xml b/docs/command_interface/pom.xml
index 5d24b1d..587f74d 100644
--- a/docs/command_interface/pom.xml
+++ b/docs/command_interface/pom.xml
@@ -184,6 +184,10 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -202,6 +206,10 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/command_interface/src/asciidoc/_chapters/about.adoc b/docs/command_interface/src/asciidoc/_chapters/about.adoc
index dccb28f..fb54286 100644
--- a/docs/command_interface/src/asciidoc/_chapters/about.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/about.adoc
@@ -24,14 +24,14 @@
////
= About This Document
-This guide describes how to use the Trafodion Command Interface (trafci) on a client workstation to connect to and query a Trafodion database.
+This guide describes how to use the Trafodion Command Interface (trafci) on a client workstation to connect to and query a {project-name} database.
The trafci enables you to run SQL statements interactively or from script files.
== Intended Audience
-This guide is intended for database administrators and support personnel who are maintaining and monitoring a Trafodion database.
+This guide is intended for database administrators and support personnel who are maintaining and monitoring a {project-name} database.
== New and Changed Information
-This manual shows updated versions for Trafodion Release 1.3.0.
+This manual shows updated versions for {project-name} Release {project-version}.
== Notation Conventions
This list summarizes the notation conventions for syntax presentation in this manual.
@@ -159,20 +159,8 @@ 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:
-
-issues@trafodion.incubator.apache.org
+We encourage 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 {project-support}.
Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
-Or, even better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 5dbfa7f..dacf0ef 100644
--- a/docs/command_interface/src/asciidoc/_chapters/commands.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/commands.adoc
@@ -32,9 +32,9 @@ TrafCI supports these commands in the command-line interface or in script files
| / | Runs the previously executed SQL statement. | <<cmd_slash, / Command>>
| ALIAS | Maps a string to any interface or SQL command. | <<cmd_alias, ALIAS Command>>
| CLEAR | Clears the command console so that only the prompt appears at the top of the screen. | <<cmd_clear, CLEAR Command>>
-| CONNECT | Creates a new connection to the Trafodion database from a current or existing TrafCI session. | <<cmd_connect, CONNECT Command>>
+| CONNECT | Creates a new connection to the {project-name} database from a current or existing TrafCI session. | <<cmd_connect, CONNECT Command>>
| DELAY | Allows the TrafCI session to be in sleep mode for the specified interval. | <<cmd_delay, DELAY Command>>
-| DISCONNECT | Terminates the connection to the Trafodion database. | <<cmd_disconnect, DISCONNECT Command>>
+| DISCONNECT | Terminates the connection to the {project-name} database. | <<cmd_disconnect, DISCONNECT Command>>
| ENV | Displays attributes of the current TrafCI session. | <<cmd_env, ENV Command>>
| EXIT | Disconnects from and exits the command-line interface. | <<cmd_exit, EXIT Command>>
| FC | Edits and re-executes a previous command. This command is restricted to the command-line
@@ -50,7 +50,7 @@ interface and is disallowed in script files.
| OBEY | Runs the SQL statements and interface commands contained in a specified script file. | <<cmd_obey, OBEY Command>>
| PRUN | Runs script files in parallel. | <<cmd_prun, PRUN Command>>
| QUIT | Disconnects from and exits TrafCI. | <<cmd_quit, QUIT Command>>
-| RECONNECT | Creates a new connection to the Trafodion database using the login credentials of the last
+| RECONNECT | Creates a new connection to the {project-name} database using the login credentials of the last
successful connection. | <<cmd_reconnect, RECONNECT Command>>
| REPEAT | Re-executes a command. | <<cmd_repeat, REPEAT Command>>
| RESET LASTERROR | Resets the last error code to `0`. | <<cmd_reset_lasterror, RESET LASTERROR Command>>
@@ -347,7 +347,7 @@ specifies the host name or IP address of the database platform to which you want
=== Examples
-* This command creates a new connection to the Trafodion database from the current or existing TrafCI session:
+* This command creates a new connection to the {project-name} database from the current or existing TrafCI session:
+
```
SQL> CONNECT
@@ -355,10 +355,10 @@ SQL> CONNECT
User Name: user1
Password:
-Connected to Trafodion
+Connected to {project-name}
```
-* This command creates a new connection to the Trafodion database from the current or existing TrafCI session:
+* This command creates a new connection to the {project-name} database from the current or existing TrafCI session:
+
```
SQL> CONNECT user1/password
@@ -366,7 +366,7 @@ SQL> CONNECT user1/password
Connected to Trafodion
```
-* This command creates a new connection to the Trafodion database from the current or existing TrafCI session:
+* This command creates a new connection to the {project-name} database from the current or existing TrafCI session:
+
```
SQL> CONNECT user1/password@host0101
@@ -374,7 +374,7 @@ SQL> CONNECT user1/password@host0101
Connected to Trafodion
```
-* This command creates a new connection to the Trafodion database from the current or existing TrafCI session:
+* This command creates a new connection to the {project-name} database from the current or existing TrafCI session:
+
```
SQL> CONNECT user2
@@ -446,7 +446,7 @@ is the same as the condition parameter defined for the <<cmd_if_then, IF&8230;TH
=== Considerations
* You must enter the command on one line. The command does not require an SQL terminator.
-* After you disconnect from the Trafodion database, you can still run these interface commands:
+* After you disconnect from the {project-name} database, you can still run these interface commands:
+
[cols="15%,20%,28%,32%"]
|===
@@ -464,7 +464,7 @@ is the same as the condition parameter defined for the <<cmd_if_then, IF&8230;TH
<<<
=== Examples
-This command terminates the connection to the Trafodion database. You can connect to the Trafodion database by using the `CONNECT`
+This command terminates the connection to the {project-name} database. You can connect to the {project-name} database by using the `CONNECT`
and `RECONNECT` commands:
```
@@ -1156,7 +1156,7 @@ SQL> LABEL MyNewLabel
* This command creates a label using a quoted string:
+
```
-SQL> LABEL "Trafodion Label"
+SQL> LABEL "{project-name} Label"
```
<<<
@@ -1826,7 +1826,7 @@ SQL> QUIT IF errorcode=4082
[[cmd_reconnect]]
== RECONNECT Command
-The `RECONNECT` command creates a new connection to the Trafodion database using the login credentials of the last successful connection.
+The `RECONNECT` command creates a new connection to the {project-name} database using the login credentials of the last successful connection.
=== Syntax
@@ -1843,7 +1843,7 @@ If TrafCI was invoked with the `-noconnect` launch parameter, TrafCI prompts you
=== Examples
-* This command creates a new connection to the Trafodion database using the login credentials of the last successful connection:
+* This command creates a new connection to the {project-name} database using the login credentials of the last successful connection:
+
```
SQL> RECONNECT
@@ -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/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} 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/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_].
<<<
=== Syntax
@@ -3046,7 +3046,7 @@ SQL>
```
For more information on the STATISTICS command, see the
-http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_].
<<<
[[cmd_set_time]]
@@ -4264,8 +4264,8 @@ For more information, see <<interactive_log_output, Log Output>>.
[[cmd_version]]
== VERSION Command
-The `VERSION` command displays the build versions of the Trafodion database, Trafodion Connectivity Service,
-Trafodion JDBC Type 4 Driver, and TrafCI.
+The `VERSION` command displays the build versions of the {project-name} database, {project-name} Connectivity Service,
+{project-name} JDBC Type 4 Driver, and TrafCI.
=== Syntax
@@ -4279,7 +4279,7 @@ You must enter the command on one line. The command does not require an SQL term
=== Example
-* This command shows versions of the Trafodion database, Trafodion Connectivity Service, Trafodion JDBC Type 4 Driver, and TrafCI:
+* This command shows versions of the {project-name} database, {project-name} Connectivity Service, {project-name} JDBC Type 4 Driver, and TrafCI:
+
```
SQL> VERSION
@@ -4294,7 +4294,7 @@ SQL>
<<<
* If TrafCI is started with the -noconnect parameter, the `VERSION` command displays only TrafCI and the
-Trafodion JDBC Type 4 Driver versions.
+{project-name} JDBC Type 4 Driver versions.
+
```
C:\Program Files (x86)\Apache Software Foundation\Trafodion Command Interface\bin> TRAFCI -noconnect
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/install.adoc
----------------------------------------------------------------------
diff --git a/docs/command_interface/src/asciidoc/_chapters/install.adoc b/docs/command_interface/src/asciidoc/_chapters/install.adoc
index 6251908..c204432 100644
--- a/docs/command_interface/src/asciidoc/_chapters/install.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/install.adoc
@@ -28,7 +28,7 @@
== Install trafci
To install trafci on a client workstation, follow the procedures in the
-http://trafodion.incubator.apache.org/docs/client_install/index.html[Trafodion Client Installation Guide].
+{docs-url}/client_install/index.html[{project-name} Client Installation Guide].
Ensure that you set up the Java Path per the instructions in that guide.
== Test trafci Launch
@@ -45,5 +45,5 @@ image:{images}/launch02.jpg[image]
* The Java path is set to the correct location. See <<install_verify, Verify and Set the Java Path>>.
* You installed the trafci and JDBC software files correctly.
-See the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[Trafodion Client Installation Guide].
+See the {docs-url}/client_install/index.html[{project-name} Client Installation Guide].
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 9e73208..126ecc5 100644
--- a/docs/command_interface/src/asciidoc/_chapters/interactive.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Run Commands Interactively
@@ -51,7 +51,7 @@ You can continue any SQL statement over multiple lines, breaking that statement
within a word, a numeric literal, or a multi-character 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/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} 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/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_].
The `SHOW SCHEMA` command displays the current schema for the session.
@@ -443,9 +443,9 @@ For more information, see the <<cmd_help, HELP Command>>.
== Run SQL Statements
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.
+SQL utilities, and other SQL-related commands that the {project-name} database engine supports.
For more information about those SQL statements, see the
-http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} 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/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} 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/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_].
<<<
[[interactive_log_output]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/command_interface/src/asciidoc/_chapters/introduction.adoc b/docs/command_interface/src/asciidoc/_chapters/introduction.adoc
index a54532b..7d3a67c 100644
--- a/docs/command_interface/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/introduction.adoc
@@ -22,10 +22,10 @@
= Introduction
The Trafodion Command Interface (trafci) is a command-line interface that you download and install on a client workstation that has the
-Trafodion JDBC Type 4 Driver installed. Operating systems that support the JDBC driver include Windows and Linux. The JDBC driver connects
-trafci on a client workstation to a Trafodion database.
+{project-name} JDBC Type 4 Driver installed. Operating systems that support the JDBC driver include Windows and Linux. The JDBC driver connects
+trafci on a client workstation to a {project-name} database.
-image:{images}/VST101.jpg["trafci Connected to a Trafodion Database"]
+image:{images}/VST101.jpg["trafci Connected to a {project-name} Database"]
trafci enables you to perform daily administrative and database management tasks by running SQL statements or other commands
interactively or from script files. You can also run trafci from a Perl or Python command line or from Perl or Python programs.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/launch.adoc
----------------------------------------------------------------------
diff --git a/docs/command_interface/src/asciidoc/_chapters/launch.adoc b/docs/command_interface/src/asciidoc/_chapters/launch.adoc
index 1aa42ee..f4a61ef 100644
--- a/docs/command_interface/src/asciidoc/_chapters/launch.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/launch.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Launch trafci
@@ -58,7 +58,7 @@ image:{images}/shortct1.jpg[width=400,height=400,alt="Select trafci.cmd file"]
image:{images}/shortct2.jpg[width=400,height=400,alt="Select shortcut from menu"]
+
For the locations of the installed trafci software files,
-see the http://trafodion.incubator.apache.org/docs/client_install/latest/index.html[_Trafodion Client Installation Guide_].
+see the {docs-url}/client_install/index.html[_{project-name} Client Installation Guide_].
3. Type a name for the shortcut and click *Finish*:
+
@@ -97,7 +97,7 @@ In the terminal window, enter:
_<trafci-installation-directory>_ is the directory where you installed the trafci software files.
For more information,
-see the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_].
+see the {docs-url}/client_install/index.html[_{project-name} Client Installation Guide_].
=== Set `trafci.sh` PATH
@@ -119,7 +119,7 @@ export PATH=/<trafci-installation-directory>/trafci/bin/: ...
+
_trafci-installation-directory_ is the directory where you installed the trafci software files.
For more information,
-see the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_].
+see the {docs-url}/client_install/index.html[_{project-name} Client Installation Guide_].
Check that no space is after the colon (`:`) in the path.
+
NOTE: In the C shell, use the `setenv` command instead of `export`.
@@ -335,7 +335,7 @@ Connected to Trafodion SQL>
** For a session started using redirected or piped input.
In these cases, trafci returns an error message and closes the session. You must re-launch the trafci session
-to connect to the Trafodion database.
+to connect to the {project-name} database.
<<<
[[trafci_option_params]]
@@ -391,7 +391,7 @@ For more information, see <<trafci_run_script, Run Script When Launching trafci>
+
For more information, see <<trafci_noconnect, Launch trafci Without Connecting to the Database>>.
-| `-version` | Displays the build version of trafci and the Trafodion JDBC Type 4
+| `-version` | Displays the build version of trafci and the {project-name} JDBC Type 4
Driver. Upon completion of the display, the client exits. +
+
If any other parameters are included with the `-version` parameter, they are ignored. +
@@ -543,7 +543,7 @@ SQL>SET SQLPROMPT *
[[trafci_noconnect]]
== Launch trafci Without Connecting to the Database
-To start trafci without connecting to a Trafodion database, use the `-noconnect option`.
+To start trafci without connecting to a {project-name} database, use the `-noconnect option`.
See <<cmd_disconnect, `DISCONNECT` command>> for a list of interface commands that can
be run without a connection.
@@ -566,7 +566,7 @@ cd <trafci-installation-directory>/trafci/bin
<<<
[[trafci_with_version]]
== Run trafci With `-version`
-To display the build version of trafci and the Trafodion JDBC Type 4 Driver, use the `-version`
+To display the build version of trafci and the {project-name} JDBC Type 4 Driver, use the `-version`
option. If other parameters are included with the `-version` parameter, they are ignored.
*Example*
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc
----------------------------------------------------------------------
diff --git a/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc b/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc
index 2516849..3c80303 100644
--- a/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Run trafci From Perl or Python
@@ -198,7 +198,7 @@ You can launch the Perl or Python wrapper scripts as shown below:
=== Example Perl Program (`sample.pl`)
You can download the `sample.pl` example from
-http://trafodion.incubator.apache.org/docs/command_interface/resources/source/sample.pl.
+{docs-url}/command_interface/resources/source/sample.pl.
Alternatively, copy and paste the following code into a file named `sample.pl`:
@@ -211,7 +211,7 @@ include::{sourcedir}/sample.pl[]
=== Example Python Program (`sample.py`)
You can download the `sample.py` example from
-http://trafodion.incubator.apache.org/docs/command_interface/resources/source/sample.py.
+{docs-url}/command_interface/resources/source/sample.py.
Alternatively, copy and paste the following code into a file named `sample.py`:
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 e74107d..245ca9d 100644
--- a/docs/command_interface/src/asciidoc/_chapters/scripts.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/scripts.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Run Scripts
@@ -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/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_].
+{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_].
[[script_commands]]
== Commands
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/command_interface/src/asciidoc/index.adoc b/docs/command_interface/src/asciidoc/index.adoc
index a9d1bec..dc5739b 100644
--- a/docs/command_interface/src/asciidoc/index.adoc
+++ b/docs/command_interface/src/asciidoc/index.adoc
@@ -32,7 +32,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
:images: ../images
:sourcedir: ../../resources/source
@@ -42,29 +43,13 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-**License Statement**
+include::../../shared/license.txt[]
+<<<
-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
+include::../../shared/acknowledgements.txt[]
-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.
-
-**Acknowledgements**
-
-Microsoft� and Windows� are U.S. registered trademarks of Microsoft Corporation. Java� is a registered trademark of Oracle and/or its affiliates. DbVisualizer\u2122 is a trademark of DbVis Software AB.
-
-*Revision History*
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 2.0.0 | To be announced.
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/pom.xml
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/pom.xml b/docs/cqd_reference/pom.xml
index 2075c15..cfc3c80 100644
--- a/docs/cqd_reference/pom.xml
+++ b/docs/cqd_reference/pom.xml
@@ -186,6 +186,10 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -204,6 +208,10 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
[02/22] incubator-trafodion git commit: JDBCT$ Programmer's Reference
Guide
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_data.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_data.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_data.adoc
new file mode 100644
index 0000000..332f351
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_data.adoc
@@ -0,0 +1,553 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[working-with-blob-and-clob-data]]
+= Working with BLOB and CLOB Data
+
+This chapter describes working with BLOB and CLOB data in JDBC
+applications. You can use the standard interface described in the JDBC
+3.0 API specification to access BLOB and CLOB data in a {project-name}
+database with support provided by the Type 4 driver.
+
+BLOB and CLOB are not native data types in a {project-name} database.
+But, database administrators can create and manage {project-name}
+database tables that have BLOB and CLOB columns by using the Type 4
+driver or other tools as described in
+<<managing-the-sql-tables-for-blob-and-clob-data, Managing the SQL Tables for BLOB and CLOB Data>>.
+
+For management purposes, CLOB and BLOB data is referred to as large
+object (LOB) data, which can represent either data type.
+
+[[architecture-for-lob-support]]
+== Architecture for LOB Support
+
+The tables that support LOB data are:
+
+*LOB Architecture: Tables for LOB Data Support*
+[cols="15%,85%",options="header" ]
+|===
+| Table | Description
+| *Base table* | Referenced by JDBC applications to insert, store, read, and update BLOB and CLOB data.
+In the base table, the Type 4 driver maps the BLOB and CLOB columns into a data-locator column. The data-locator column points to
+the actual LOB data that is stored in a separate user table called the LOB table.
+| *LOB table* | Actually contains the BLOB and CLOB data in chunks. A CLOB or BLOB object is identified by a data locator. LOB tables have two
+formats: LOB table for BLOB data and a LOB table for CLOB data.
+|===
+
+image:{images}/lob_tables.jpg[LOB table layout]
+
+[[setting-properties-for-the-lob-table]]
+== Setting Properties for the LOB Table
+
+Before running the JDBC application that uses BLOB and CLOB data through
+the JDBC API, the database administrator must create the LOB tables. For
+information on creating LOB tables, see
+<<managing-lob-data-by-using-the-lob-admin-utility, Managing LOB Data by Using the Lob Admin Utility>>.
+
+The JDBC applications that access BLOB or CLOB data must specify the
+associated LOB table names and, optionally, configure the
+`reserveDataLocators` property.
+
+[[specifying-the-lob-table]]
+=== Specifying the LOB Table
+
+At run time, a user JDBC application notifies the Type 4 driver of the
+name or names of the LOB tables associated with the CLOB or BLOB columns
+of the base tables being accessed by the application. One LOB table or
+separate tables can be used for BLOB and CLOB data.
+
+The JDBC application specifies a LOB table name either through a system
+parameter or through a Java Property object by using one of the
+following properties, depending on the LOB column type:
+
+For more information about using these properties, see
+<<lob-table-name-properties, LOB Table Name Properties>>.
+
+[[reserving-data-locators]]
+=== Reserving Data Locators
+
+A data locator is the reference pointer value (SQL `LARGEINT` data type)
+that is substituted for the BLOB or CLOB column in the base table
+definition. Each object stored into the LOB table is assigned a unique
+data locator value. Because the LOB table is a shared resource among all
+accessors that use the particular LOB table, reserving data locators
+reduces contention for getting the next value. The default setting is
+100 reserved data locators; therefore, each JVM instance can insert 100
+large objects (not chunks) before needing a new allocation.
+
+Specify the number of data locators (n) to reserve for your application
+by using the Type 4 driver property `hpt4jdbc.reserveDataLocators`. For
+information about specifying this property, see
+<<reserveDataLocators, reserveDataLocators Property>>.
+
+
+[[storing-clob-data]]
+== Storing CLOB Data
+
+[[inserting-clob-columns-by-using-the-clob-interface]]
+=== Inserting CLOB Columns by Using the Clob Interface
+
+When you insert a row containing a CLOB data type, and before the column
+can be updated with real CLOB data, you can insert a row that has an
+empty CLOB value. To insert an empty CLOB value in a {project-name}
+database, specify the `EMPTY_CLOB()` function for the CLOB column in the
+insert statement.
+
+* The `EMPTY_CLOB()` function is an {project-name} database software-specific
+function and might not work on other databases.
+
+* Do not use the `EMPTY_CLOB()` function when using the `PreparedStatement` interface.
+
+The Type 4 driver scans the SQL string for the `EMPTY_CLOB()` function and
+substitutes the next-available data locator.
+
+Then, obtain the handle to the empty CLOB column by selecting the CLOB
+column for update. The following code illustrates how to obtain the
+handle to an empty CLOB column:
+
+[source, java]
+----
+Clob myClob = null ;
+
+Statement s = conn.createStatement() ;
+ResultSet rs =
+ s.executeQuery( "SELECT myclobcolumn FROM mytable WHERE ... FOR UPDATE" ) ;
+if ( rs.next() )
+ myCLOB = rs.getClob( 1 ) ;
+----
+
+You can now write data to the CLOB column. See
+<<writing-ascii-or-mbcs-data-to-a-clob-column, Writing ASCII or MBCS Data to a CLOB Column>>.
+
+NOTE: *Limitation*: Do not rename the CLOB column in the select query.
+
+[[writing-ascii-or-mbcs-data-to-a-clob-column]]
+=== Writing ASCII or MBCS Data to a CLOB Column
+
+You can write ASCII or MBCS data to a CLOB column.
+
+NOTE: Multi-byte Character Set (MBCS) data and ASCII data are handled the same way.
+
+[[ascii-data]]
+==== ASCII Data
+
+To write ASCII or MBCS data to the CLOB column, use the Clob interface.
+The following code illustrates using the `setAsciiStream` method of the
+Clob interface to write CLOB data.
+
+[source, java]
+----
+// stream begins at position: 1
+long pos = 1;
+
+// String containing the ASCII data
+String s ;
+
+// Obtain the output stream to write Clob data
+OutputStream os = myClob.setAsciiStream( pos ) ;
+
+// write Clob data using OutputStream
+byte[] myClobData = s.getBytes() ;
+os.write( myClobData ) ;
+----
+
+The Type 4 driver splits the output stream into chunks and stores the
+chunks in the LOB table.
+
+
+[[inserting-clob-data-by-using-the-preparedstatement-interface]]
+=== Inserting CLOB Data by Using the PreparedStatement Interface
+
+You can use the `PreparedStatement` interface to insert a CLOB column
+using ASCII or MBCS data.
+
+[[ascii-data]]
+==== ASCII Data
+
+To insert a CLOB column using ASCII or MBCS data from an `InputStream`,
+use the `PreparedStatement` interface to insert the CLOB column.
+
+[source, java]
+----
+InputStream inputAsciiStream ;
+
+PreparedStatement ps =
+ conn.prepareStatement( "INSERT INTO mytable (myclobcolumn) VALUES (?)" ) ;
+
+ps.setAsciiStream( 1, inputAsciiStream, length_of_data ) ;
+ps.executeUpdate() ;
+----
+
+The Type 4 driver reads the data from `InputStream` and writes the data to
+the LOB table. The Type 4 driver substitutes the next-available data
+locator for the parameter of the CLOB column in the table.
+
+[[inserting-a-clob-object-by-using-the-setclob-method]]
+=== Inserting a Clob Object by Using the setClob Method
+
+Your JDBC application cannot directly instantiate a `Clob` object. To
+perform an equivalent operation:
+
+1. Obtain a `Clob` object by using the `getClob` method of the `ResultSet` interface.
+2. Insert the `Clob` object into another row by using the `setClob` method
+of the `PreparedStatement` interface.
+
+In this situation, the Type 4 driver generates a new data locator and,
+when the `PreparedStatement` is executed, copies the contents of the source `Clob`
+into the new `Clob` object.
+
+[[reading-clob-data]]
+== Reading CLOB Data
+
+[[reading-ascii-data-from-a-clob-column]]
+=== Reading ASCII Data from a CLOB Column
+
+To read ASCII or MBCS data from a CLOB column, use the `Clob` interface or `InputStream`.
+
+Using the Clob interface:
+
+[source, java]
+----
+// Obtain the Clob from ResultSet
+Clob myClob = rs.getClob( "myClobColumn" ) ;
+
+// Obtain the input stream to read Clob data
+InputStream is = myClob.getAsciiStream() ;
+
+// read Clob data using the InputStream
+byte[] myClobData ;
+myClobData = new byte[ length ] ;
+
+is.read( myClobData, offset, length ) ;
+----
+
+To read ASCII or MBCS data from the CLOB column by using `InputStream`:
+
+[source, java]
+----
+// obtain the InputStream from ResultSet
+InputStream is = rs.getAsciiStream( "myClobColumn" ) ;
+
+// read Clob data using the InputStream
+byte[] myClobData ;
+myClobData = new byte[length] ;
+
+is.read( myClobData, offset, length ) ;
+----
+
+[[updating-clob-data]]
+== Updating CLOB Data
+
+To update CLOB data, use the methods in the `Clob` interface or use the
+`updateClob` method of the `ResultSet` interface. The Type 4 driver makes
+changes directly to the CLOB data. Therefore, the Type 4 driver returns
+`false` to the `locatorsUpdateCopy` method of the `DatabaseMetaData` interface.
+Applications do not need to issue a separate update statement to update the CLOB data.
+
+[[updating-clob-objects-with-the-updateclob-method]]
+=== Updating Clob Objects with the updateClob Method
+
+Unlike some LOB support implementations, the Type 4 driver updates the
+CLOB data directly in the database. So, when the `Clob` object is same in
+the `updateClob` method as the `Clob` object obtained using `getClob`, the
+`updateRow` method of the `ResultSet` interface does nothing with the `Clob`
+object.
+
+When the `Clob` objects differ, then the `Clob` object in the `updateClob` method
+behaves as if the `setClob` method was issued. See
+<<inserting-a-clob-object-by-using-the-setclob-method, Inserting a Clob Object by Using the setClob Method>>.
+
+[[replacing-clob-objects]]
+=== Replacing Clob Objects
+
+You can replace Clob objects in the following ways:
+
+* Use the `EMPTY_CLOB()` function to replace the `Clob` object with the
+empty `Clob` object, then insert new data as described under
+<<inserting-clob-columns-by-using-the-clob-interface, Inserting CLOB Columns by Using the Clob Interface>>.
+* Use the `PreparedStatement.setAsciiStream()` or `setCharacterStream()`
+method to replace the existing `Clob` object with new CLOB data.
+* Use the `setClob` or `updateClob` method to replace the existing CLOB
+objects as explained under
+<<inserting-a-clob-object-by-using-the-setclob-method, Inserting a Clob Object by Using the setClob Method>> and
+<<updating-clob-objects-with-the-updateclob-method, Updating Clob Objects with the updateClob Method>>.
+
+[[deleting-clob-data]]
+== Deleting CLOB Data
+
+To delete CLOB data, the JDBC application uses the `SQL DELETE` statement
+to delete the row in the base table.
+
+When the row containing the CLOB column is deleted by the JDBC
+application, the corresponding CLOB data is automatically deleted, too.
+
+See also
+<<null-and-empty-blob-or-empty-clob-value, NULL and Empty BLOB or Empty CLOB Value>>.
+
+[[storing-blob-data]]
+== Storing BLOB Data
+
+Perform operations on BLOB columns that are similar to those operations
+used on CLOB columns.
+
+* Use the `EMPTY_BLOB()` function in the insert statement to create an
+empty BLOB column in the database.
+* Use the `setBinaryStream` method of the `Blob` interface to obtain the
+`InputStream` to read BLOB data.
+* Use the `getBinaryStream` method of the `Blob` interface to obtain the
+`OutputStream` to write BLOB data.
+* Use the `setBinaryStream` of the `PreparedStatement` interface to write the
+data to the BLOB column.
+
+[[inserting-a-blob-column-by-using-the-blob-interface]]
+=== Inserting a BLOB Column by Using the Blob Interface
+
+When you insert a row containing a BLOB data type, you can insert the
+row using an empty BLOB value before the column can be updated with real
+BLOB data. To insert an empty BLOB value in a {project-name} database,
+specify `EMPTY_BLOB()` function for the BLOB column in the insert
+statement.
+
+The Type 4 driver scans the SQL string for the `EMPTY_BLOB()` function and
+substitutes the next-available data locator.
+
+NOTE: The `EMPTY_BLOB()` function is an {project-name} database software
+specific function and might not work on other databases. Do not use the `EMPTY_BLOB()` function when using the `PreparedStatement`
+interface.
+
+Then, obtain the handle to the empty BLOB column by selecting the BLOB
+column for update. The following code illustrates how to obtain the
+handle to an empty BLOB column:
+
+[source, java]
+----
+Blob myBlob = null ;
+
+Statement s = conn.createStatement() ;
+ResultSet rs =
+ s.executeQuery("SELECT myblobcolumn FROM mytable WHERE ... FOR UPDATE" ) ;
+
+if ( rs.next() )
+ myBlob = rs.getBlob( 1 ) ;
+----
+
+You can now write data to the BLOB column. See
+<<writing-binary-data-to-a-blob-column, Writing Binary Data to a BLOB Column>>.
+
+NOTE: *Limitation:* Do not rename the BLOB column in the select query.
+
+[[writing-binary-data-to-a-blob-column]]
+=== Writing Binary Data to a BLOB Column
+
+To write data to the BLOB column, use the `Blob` interface. The following
+code illustrates using the `setBinaryStream` method of the `Blob` interface
+to write BLOB data:
+
+[source, java]
+----
+// Stream begins at position: 1
+long pos = 1 ;
+
+// String containing the binary data
+String s ;
+
+// Obtain the output stream to write Blob data
+OutputStream os = myBlob.setBinaryStream( pos ) ;
+
+// write Blob data using OutputStream
+byte[] myBlobData = s.getBytes() ;
+os.write( myBlobData ) ;
+----
+
+The Type 4 driver splits the output stream into chunks and stores the chunks in the LOB table.
+
+[[inserting-a-blob-column-by-using-the-preparedstatement-interface]]
+=== Inserting a BLOB Column by Using the PreparedStatement Interface
+
+To insert a BLOB column that has binary data from an `InputStream`, use
+the `PreparedStatement` interface:
+
+[source, java]
+----
+InputStream inputBinary ;
+
+PreparedStatement ps =
+ conn.prepareStatement( "INSERT INTO mytable (myblobcolumn) VALUES (?)" ) ;
+
+ps.setBinaryStream( 1, inputBinary, length_of_data ) ;
+ps.executeUpdate() ;
+----
+
+The Type 4 driver reads the data from `InputStream` and writes the data to
+the LOB table. The Type 4 driver substitutes the next-available data
+locator for the parameter of the BLOB column in the table.
+
+[[inserting-a-blob-object-by-using-the-setblob-method]]
+=== Inserting a Blob Object by Using the setBlob Method
+
+Your JDBC application cannot directly instantiate a `Blob` object. To
+perform an equivalent operation:
+
+1. Obtain a `Blob` object by using the `getBlob` method of the `ResultSet` interface.
+2. Insert the `Blob` object into another row by using the `setBlob` method
+of the `PreparedStatement` interface.
+
+In this situation, the Type 4 driver generates a new data locator and
+copies the contents of the source `Blob` into the new `Blob` object when the
+application issues the `setBlob` method of the `PreparedStatement` interface.
+
+
+[[reading-binary-data-from-a-blob-column]]
+== Reading Binary Data from a BLOB Column
+
+To read binary data from the BLOB column, use the `Blob` interface or `InputStream`.
+
+Using the Blob interface:
+
+[source, java]
+----
+// Obtain the Blob from ResultSet
+Blob myBlob = rs.getBlob( "myBlobColumn" ) ;
+
+// Obtain the input stream to read Blob data
+InputStream is = myBlob.getBinaryStream() ;
+
+// read Blob data using the InputStream
+byte[] myBlobData ;
+myBlobData = new byte[ length ] ;
+
+is.read( myBlobData, offset, length ) ;
+----
+
+Using InputStream:
+
+[source, java]
+----
+// obtain the InputStream from ResultSet
+InputStream is = rs.getBinaryStream( "myBlobColumn" ) ;
+
+// read Blob data using the InputStream
+byte[] myBlobData ;
+myBlobData = new byte[ length ] ;
+
+is.read( myBlobData, offset, length ) ;
+----
+
+[[updating-blob-data]]
+== Updating BLOB Data
+
+To update BLOB data, use the methods in the `Blob` interface or use the
+`updateBlob` method of the `ResultSet` interface. The Type 4 driver makes
+changes to the BLOB data directly. Therefore, the Type 4 driver returns
+`false` to the `locatorsUpdateCopy` method of the
+`DatabaseMetaData` interface. Applications do not need to issue a separate
+update statement to update the BLOB data.
+
+[[updating-blob-objects-by-using-the-updateblob-method]]
+=== Updating Blob Objects by Using the updateBlob Method
+
+Unlike some LOB support implementations, the Type 4 driver updates the
+BLOB data directly in the database. So, when the Blob object is same in
+the `updateBlob` method as the object obtained using `getBlob`, the
+`updateRow` method of the `ResultSet` interface does nothing with the `Blob`
+object.
+
+When the `Blob` objects differ, the `Blob` object in the `updateBlob` method
+behaves as if the `setBlob` method was issued. See
+<<inserting-a-blob-object-by-using-the-setblob-method, Inserting a Blob Object by Using the setBlob Method>>.
+
+[[replacing-blob-objects]]
+=== Replacing Blob Objects
+
+You can replace Blob objects in the following ways:
+
+* Use the `EMPTY_BLOB()` function to replace the `Blob` object with the
+empty `Blob` object.
+* Replace an existing `Blob` object in a row by inserting the `Blob` with
+new data as described under
+<<inserting-a-blob-column-by-using-the-blob-interface, Inserting a BLOB Column by Using the Blob Interface>>.
+* Use the `setBinaryStream()` method to of the `PreparedStatement` interface
+to replace the existing `Blob` object with new BLOB data.
+* Use the `setBlob` or `updateBlob` methods to replace the existing BLOB
+objects as explained under
+<<inserting-a-blob-object-by-using-the-setblob-method, Inserting a Blob Object by Using the setBlob Method>> and
+<<updating-blob-objects-by-using-the-updateblob-method, Updating Blob Objects by Using the updateBlob Method>>.
+
+[[deleting-blob-data]]
+== Deleting BLOB Data
+
+To delete BLOB data, the JDBC application uses the `SQL DELETE` statement
+to delete the row in the base table.
+
+When the row containing the BLOB column is deleted by the application,
+the corresponding BLOB data is automatically deleted.
+
+See also
+<<null-and-empty-blob-or-empty-clob-value, NULL and Empty BLOB or Empty CLOB Value>>.
+
+[[null-and-empty-blob-or-empty-clob-value]]
+== NULL and Empty BLOB or Empty CLOB Value
+
+The data locator can have a `NULL` value if the BLOB or CLOB column is
+omitted in the insert statement. The Type 4 driver returns `NULL` when the
+application retrieves the value for such a column.
+
+When the application uses the `EMPTY_BLOB()` function or the `EMPTY_CLOB()`
+function to insert empty BLOB or CLOB data into the BLOB or CLOB column,
+the Type 4 driver returns the `Blob` or `Clob` object with no data.
+
+[[transactions-involving-blob-and-clob-access]]
+== Transactions Involving Blob and Clob Access
+
+You must ensure that your JDBC applications control the transactions
+when the BLOB columns or CLOB columns are accessed or modified. To
+control the transaction, set the connection to autocommit OFF mode.
+
+All LOB data access or modification is done under the application's
+transaction. When the autocommit mode is ON and LOB data is accessed or
+modified, the Type 4 driver throws the SQLException, Autocommit is on
+and LOB objects are involved.
+
+[[access-considerations-for-clob-and-blob-objects]]
+== Access Considerations for Clob and Blob Objects
+
+The Type 4 driver allows all the valid operations on the current `Clob`
+object or `Blob` object, called a "LOB object." LOB objects are current as
+long as the row that contains these LOB objects is the current row. The
+Type 4 driver throws an SQLException, issuing the following message,
+when the application attempts to perform operations on a LOB object that
+is not current:
+
+```
+Lob object {object-id} is not current
+```
+
+Only one `InputStream` or `Reader` and one `OutputStream` or `Writer` can be
+associated with the current LOB object.
+
+* When the application obtains the `InputStream` or `Reader` from the LOB
+object, the Type 4 driver closes the `InputStream` or `Reader` that is
+already associated with the LOB object.
+* Similarly, when the application obtains the `OutputStream` or `Writer`
+from the LOB object, the Type 4 driver closes the `OutputStream` or `Writer`
+that is already associated with the LOB object.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc
new file mode 100644
index 0000000..7fd5794
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/lob_management.adoc
@@ -0,0 +1,288 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[managing-the-sql-tables-for-blob-and-clob-data]]
+= Managing the SQL Tables for BLOB and CLOB Data
+
+This chapter describes for database administrators the creation and
+management of the tables required to support LOB data.
+
+NOTE: BLOB and CLOB are not native data types in a {project-name}
+database. But database administrators can create SQL base tables that
+have BLOB and CLOB columns by using either the Type 4 driver or special
+SQL syntax in as described in this chapter.
+
+For management purposes, CLOB and BLOB data is referred to as large
+object (LOB) data, which can represent either data type.
+
+[[before-you-begin-managing-lob-data]]
+== Before You Begin Managing LOB Data
+
+Before reading this chapter, also read
+<<Architecture for LOB Support, Architecture for LOB Support>>,
+which describes the files for the tables that contain LOB data.
+
+[creating-base-tables-that-have-lob-columns]]
+== Creating Base Tables that Have LOB Columns
+
+You can use trafci or write JDBC programs to create base tables that have LOB columns.
+
+[[data-types-for-lob-columns]]
+=== Data Types for LOB Columns
+
+The data types for the LOB columns are:
+
+* `CLOB`: Character large object data
+* `BLOB`: Binary large object data
+
+NOTE: The CLOB and BLOB data type specification is special syntax that
+is allowed for use in base tables accessed by the Type 4 driver as
+described in this manual.
+
+[[using-trafci-to-create-base-tables-that-have-lob-columns]]
+=== Using trafci To Create Base Tables that Have LOB Columns
+
+To create a base table that has LOB columns using trafci:
+
+1. Type this special commands in to enable creating tables that have LOB columns:
++
+```
+CONTROL QUERY DEFAULT TRAF_BLOB_AS_VARCHAR 'OFF' ;
+CONTROL QUERY DEFAULT TRAF_CLOB_AS_VARCHAR 'OFF' ;
+```
+
+2. Type the CREATE TABLE statement; for example, you might use the
+following simple form of the statement:
++
+```
+CREATE TABLE table1
+( c1 INTEGER NOT NULL
+, c2 CLOB
+, c3 BLOB
+, PRIMARY KEY( c1 )
+)
+;
+```
++
+* `table1`: The name of the base table.
++
+NOTE: If different LOB tables are used for storing BLOB or CLOB data,
+the base table name for a table with BLOB or CLOB columns must be unique
+across all catalogs and schemas. Otherwise, the driver will give
+incorrect data to the application in cases where the LOB tables used get
+erroneously switched or changed.
+* `c1 Column 1`: Defined as the INTEGER data type with the NOT NULL constraint.
+* `c2 Column 2`: Defined as the CLOB data type.
+* `c3 Column 3`: Defined as the BLOB data type.
+* `PRIMARY KEY`: Specifies `c1` as the primary key.
+
+Use this example as the archetype for creating base tables. For
+information about valid names for tables (`table1`) and
+columns (`c1`, `c2`, and `c3`) and for information about the CREATE TABLE statement, see the
+{docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual].
+
+[[using-jdbc-programs-to-create-base-tables-that-have-lob-columns]]
+=== Using JDBC Programs To Create Base Tables that Have LOB Columns
+
+When using a JDBC Program to create base tables that have LOB columns,
+put the CREATE TABLE statements in the program as you would any other
+SQL statement. For an example of the CREATE TABLE statement, see the discussion
+<<using-trafci-to-create-base-tables-that-have-lob-columns, Using trafci To Create Base Tables that Have LOB Columns>> .
+
+[[managing-lob-data-by-using-the-lob-admin-utility]]
+== Managing LOB Data by Using the Lob Admin Utility
+
+Use the Lob Admin Utility (T4LobAdmin) for the following tasks:
+
+* Creating the LOB table (a table that holds LOB data).
+* Creating the SQL triggers for the LOB columns in the base tables to ensure that orphan LOB data does not occur in a LOB table.
+
+NOTE: If you are creating triggers, ensure that the base table that
+contains the CLOB column or BLOB column has already been created.
+
+Information about using the Lob Admin Utility is described under these topics.
+
+[[running-the-lob-admin-utility]]
+=== Running the Lob Admin Utility
+
+Run the T4LobAdmin utility from the workstation. The format of the
+command is:
+
+```
+java [java_options] org.trafodion.t4jdbc.T4LobAdmin [prog_options] [table_name]
+```
+
+[[java-options]]
+==== java_options
+
+The `java_options` should specify the Type 4 driver properties in a
+properties file on the java command line in the `-D` option.
+
+```
+-Dhpt4jdbc.properties=<properties file name>
+```
+
+where the properties file should include the following Type 4 driver properties, as applicable:
+
+[cols="25%,75%",options="header" ]
+|===
+| Property | Description
+| `blobtablename` | Specifies LOB table for BLOB columns. Required if BLOB columns are involved. See <<lob-table-name-properties, LOB Table Name Properties>>.
+| `clobTableName` | Specifies the LOB table for CLOB columns. Required if CLOB columns are involved. See <<lob-table-name-properties, LOB Table Name Properties>>.
+| `url` | URL for the Type 4 driver connection. See <<url,url Property>>.
+| `usr` | User name for the Type 4 driver connection. See <<user, user Property>>.
+| `password` | Password associated with the user. See <<password, password Property>>.
+|===
+
+[[program-options]]
+==== program_options
+
+[cols="25%,75%",options="header" ]
+|===
+| prog_option | Description
+| `-help` | Displays help information
+| `-exec` | Runs the SQL statements that are generated.
+| `-create` | Generates SQL statements to create LOB tables. These statements describe the architecture of the tables and, therefore, provide a description of the LOB tables.
+|===
+
+[[table-name]]
+==== table_name
+
+The *table_name* represents a base table that contains LOB columns. The
+*table_name* is of the form:
+
+```
+[catalogName.][schemaName.]baseTableName
+```
+
+For information about catalog, schema, and table names, see the
+{docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual].
+
+[[help-listing-from-the-type-4-lob-admin-utility]]
+=== Help Listing From the Type 4 Lob Admin Utility
+
+To display help for the Type 4 Lob Admin Utility, type:
+
+```
+java org.trafodion.t4jdbc.T4LobAdmin -help
+```
+
+*Example*
+
+```
+Apache Trafodion T4 Lob Admin Utility 1.0 (c) Copyright 2015-2016
+org.trafodion.t4jdbc.T4LobAdmin [<prog_options>] [<table_name>]
+
+<java_options> is:
+ [-Dhpt4jdbc.properties=<properties file>]
+where <properties file> has values for the following:
+ clobTableName - CLOB table name
+ blobTableName - BLOB table name
+ url - URL used for the Type 4 connection
+ user - User name for the Type 4 connection
+ password - Password for associated with the user
+
+<prog_options> is:
+ [-exec] [-create] [-trigger] [-help] [-drop] [-out <filename>]
+where -help - Display this information.
+ -exec - Execute the SQL statements that are generated.
+ -create - Generate SQL statements to create LOB tables.
+ -trigger - Generate SQL statements to create triggers for <table_name>.
+ -drop - Generate SQL statements to drop triggers for <table_name>.
+ -out - Write the SQL statements to <filename>.
+
+<clobTableName> | <blobTableName> is:
+ <catalogName>.<schemaName>.<lobTableName>
+
+<table_name> is:
+ [<catalogName>.][<schemaName>.]<baseTableName>
+
+<baseTableName> is the table that contains LOB column(s). TableName> is the
+table that contains the LOB data.
+```
+
+[[creating-lob-tables]]
+=== Creating LOB Tables
+
+Except as noted below, use the `-create` and `-execute` options of the Lob
+Admin Utility to create LOB tables.
+
+NOTE: Partitioned LOB tables must be manually created. You cannot use
+the Lob Admin Utility if your site needs partitioned LOB tables. Do not
+use the -execute option of the Lob Admin Utility. Follow these steps to
+manually create partitioned LOB tables:
+
+1. Use the `-create` and `-out` options of the Lob Admin Utility to have SQL statements written to a file.
+2. Modify the generated SQL statements as needed for your partitioning requirements.
+3. Add the modified SQL statements to a trafci obey file.
+4. Run the script file from trafci by using obey command.
+
+[[using-sql-triggers-to-delete-lob-data]]
+=== Using SQL Triggers to Delete LOB Data
+
+Use the Type 4 Lob Admin Utility to generate triggers on SQL tables that
+delete LOB data from the LOB table when the base row is deleted. These
+triggers ensure that orphan LOB data does not occur in the LOB table. To
+manage the triggers, use these Type 4 Lob Admin Utility options:
+
+* `-trigger`: Generates SQL statements to create triggers.
+* `-drop`: Generates SQL statements to drop triggers.
+* `-exec`: Executes the SQL statements that are generated.
+
+For example, the following command generates the SQL statements to
+create the triggers for the base table `sales.paris.pictures`, which
+contains a BLOB column, and executes those statements.
+
+```
+java -Dhpt4jdbc.blobTableName=sales.paris.lobTable4pictures /
+org.trafodion.t4jdbc.T4LobAdmin -trigger -exec sales.paris.pictures
+```
+
+[[limitations-of-lob-data-clob-and-blob-data-types]]
+=== Limitations of LOB Data (CLOB and BLOB Data Types)
+
+Limitations of the CLOB and BLOB data types, collectively referred to as LOB data, are:
+
+* LOB columns can only be in the target column list of these SQL statements:
+
+** INSERT statement.
+
+** Select list of a SELECT statement.
+
+** Column name in the SET clause of an UPDATE statement.
+
+* LOB columns cannot be referenced in the SQL functions and expressions.
+
+* LOB data is not deleted from the LOB table when the base row is deleted unless a trigger is established. For information about triggers,
+see <<using-sql-triggers-to-delete-lob-data, Using SQL Triggers to Delete LOB Data>>
+
+* LOB data is not accessible if the base table name is changed.
+
+* The name of a base table that has CLOB or BLOB columns must be unique across all catalogs and schemas when more than one of these base tables
+share a single LOB table.
++
+NOTE: Adding a trigger can affect up to three schemas. For each schema, you must either own the schema or be the super ID. +
+ +
+* The schema where the trigger is created.
+* The schema where the subject table (LOB table) exists.
+* The schema where the referenced table (base table) exists.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c2116c2b/docs/jdbct4ref_guide/src/asciidoc/_chapters/messages.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/_chapters/messages.adoc b/docs/jdbct4ref_guide/src/asciidoc/_chapters/messages.adoc
new file mode 100644
index 0000000..7fc168f
--- /dev/null
+++ b/docs/jdbct4ref_guide/src/asciidoc/_chapters/messages.adoc
@@ -0,0 +1,1943 @@
+////
+/**
+ *@@@ 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 @@@
+ */
+////
+
+[[messages]]
+= Messages
+
+[[about-the-message-format]]
+== About the Message Format
+
+Messages are listed in numerical SQLCODE order. Descriptions include:
+
+```
+SQLCODE SQLSTATE message-text
+
+Cause [ What occurred to trigger the message.]
+Effect [ What is the result when this occurs. ]
+Recovery [ How to diagnose and fix the problem. ]
+```
+
+[[getting-help]]
+== Getting Help
+
+Some messages have no recovery information. Please contact {project-support} for assistance.
+
+[[type-4-driver-error-messages]]
+== Type 4 Driver Error Messages
+
+=== 01032 08S01
+
+```
+01032 08S01 Communication link failure. The server timed out or disappeared.
+```
+
+*Cause*: The connection timed out.
+
+*Effect*: Operation fails.
+
+*Recovery*: Reconnect. Set the connection timeout to an appropriate value.
+
+=== 01056 25000
+
+```
+01056 25000 Invalid transaction state.
+```
+
+*Cause*: Transaction state is incorrect.
+
+*Effect*: Operation fails.
+
+*Recovery*: Retry.
+
+=== 01118 S1008
+
+```
+01118 S1008 Operation canceled.
+```
+
+*Cause*: The operation was canceled.
+
+*Effect*: Operation fails.
+
+*Recovery*: Retry operation.
+
+=== 08001 HY000
+
+```
+08001 HY000 Retry attempts to connect to the datasource failed. May be
+ODBC server not able to register to the ODBC service process.
+```
+
+*Cause*: A server error.
+
+*Effect*: Operation fails.
+
+
+*Recovery*: Contact {project-support} to check logs for server errors and
+to analyze accompanying errors and warnings.
+
+=== 08004 HY000
+
+```
+08004 HY000 Data source rejected establishment of connection since the
+ODBC server is connected to a different client now
+```
+
+*Cause*: Connection with server has been lost. Server is now connected to a different connection.
+
+*Effect*: Operation fails.
+
+*Recovery*: Reconnect.
+
+<<<
+=== 29001 HYC00
+
+```
+HYC00 Unsupported feature - {0}
+```
+
+*Cause*: The feature listed is not supported by the JDBC driver.
+
+*Effect*: An unsupported exception is thrown, and a NULL `resultSet` is returned.
+
+*Recovery*: Remove the feature functionality from the program.
+
+=== 29002 08003
+
+```
+29002 08003 Connection does not exist
+```
+
+*Cause*: An action was attempted when the connection to the database was closed.
+
+*Effect*: The database is inaccessible.
+
+*Recovery*: Retry the action after the connection to the database is established.
+
+=== 29003 HY000
+
+```
+29003 HY000 Statement does not exist
+```
+
+*Cause*: A validation attempt was made on the getter or exec invocation on a closed statement.
+
+*Effect*: The getter or exec invocation validation fails.
+
+*Recovery*: Issue `validateGetInvocation()` or `validateExecDirectInvocation` when the statement is open.
+
+<<<
+=== 29004 HY024
+
+```
+29004 HY024 Invalid transaction isolation value.
+```
+
+*Cause*: An attempt was made to set the transaction isolation level to an invalid value.
+
+*Effect*: `HPT4Connection.setTransactionIsolation` does not set the transaction isolation value.
+
+*Recovery*: Valid isolation values are:
+`SQL_TXN_READ_COMMITTED`,
+`SQL_TXN_READ_UNCOMMITTED`,
+`SQL_TXN_REPEATABLE_READ`, and
+`SQL_TXN_SERIALIZABLE`.
+If no isolation value is specified, the default is `SQL_TXN_READ_COMMITTED`.
+
+=== 29005 HY024
+
+```
+29005 HY024 Invalid ResultSet type
+```
+
+*Cause*: An attempt was made to set an invalid `ResultSet` Type value.
+
+*Effect*: The SQL Statement call with the `resultSetType` parameter fails.
+
+*Recovery*: Valid ResultSet types are:
+`TYPE_FORWARD_ONLY`,
+`TYPE_SCROLL_INSENSITIVE`, and
+`TYPE_SCROLL_SENSITIVE`.
+
+=== 29006 HY000
+
+```
+29006 HY000 Invalid Result Set concurrency
+```
+
+*Cause*: An attempt was made to set an invalid result-set concurrency value.
+
+*Effect*: The `HPT4Statement` call with `resultSetConcurrency` fails.
+
+*Recovery*: Valid resultSetConcurrency values are: CONCUR_READ_ONLY and
+CONCUR_UPDATABLE.
+
+<<<
+=== 29007 07009
+
+```
+29007 07009 Invalid descriptor index
+```
+
+*Cause*: A `ResultSetMetadata` column parameter or a `ParameterMetaData` param
+parameter is outside of the descriptor range.
+
+*Effect*: The `ResultSetMetadata` or `ParameterMetaData` method data is not returned as expected.
+
+*Recovery*: Validate the column or parameter that is supplied to the method.
+
+=== 29008 24000
+
+```
+29008 24000 Invalid cursor state
+```
+
+*Cause*: The `ResultSet` method was called when the connection was closed.
+
+*Effect*: The method call does not succeed.
+
+*Recovery*: Make sure the connection is open before making the `ResultSet` method call.
+
+=== 29009 HY109
+
+```
+29009 HY109 Invalid cursor position
+```
+
+*Cause*: An attempt was made to perform a `deleteRow()` method or `updateRow()`
+method or `cancelRowUpdates` method when the `ResultSet` row cursor was on
+the insert row. Or, an attempt was made to perform the `insertRow()` method
+when the `ResultSet` row cursor was not on the insert row.
+
+*Effect*: The row changes and cursor manipulation do not succeed.
+
+*Recovery*: To insert a row, move the cursor to the insert row. To delete, cancel, or update a row, move the cursor from the insert row.
+
+<<<
+=== 29010 07009
+
+```
+29010 07009 Invalid column name
+```
+
+*Cause*: A column search does not contain `columnName` string.
+
+*Effect*: The column comparison or searches do not succeed.
+
+*Recovery*: Supply a valid columnName string to the `findColumn()`,
+`validateGetInvocation()`, and `validateUpdInvocation()` methods.
+
+=== 29011 07009
+
+```
+29011 07009 Invalid column index or descriptor index
+```
+
+*Cause*: A `ResultSet` method was issued that has a column parameter that is
+outside of the valid range.
+
+*Effect*: The `ResultSet` method data is not returned as expected.
+
+*Recovery*: Make sure to validate the column that is supplied to the method.
+
+=== 29012 07006
+
+```
+29012 07006 Restricted data type attribute violation.
+```
+
+*Cause*: An attempt was made to execute a method either while an invalid
+data type was set or the data type did not match the SQL column type.
+
+*Effect*: The interface method is not executed.
+
+*Recovery*: Make sure the correct method and Java data type is used for the column type.
+
+<<<
+=== 29013 HY024
+
+```
+29013 HY024 Fetch size is less than 0.
+```
+
+*Cause*: The size set for ResultSet.setFetchSize rows to fetch is less than zero.
+
+*Effect*: The number of rows that need to be fetched from the database when
+more rows are needed for a ResultSet object is not set.
+
+*Recovery*: Set the `setFetchSize()` method rows parameter to a value greater
+than zero.
+
+=== 29015 HY024
+
+```
+29015 HY024 Invalid fetch direction
+```
+
+*Cause*: The `setFetchDirection()` method direction parameter is set to an invalid value.
+
+*Effect*: The direction in which the rows in this `ResultSet` object are processed is not set.
+
+*Recovery*: Valid fetch directions are: `ResultSet.FETCH_FORWARD`,
+`ResultSet.FETCH_REVERSE`, and `ResultSet.FETCH_UNKNOWN`.
+
+=== 29017 HY004
+
+```
+29017 HY004 SQL data type not supported
+```
+
+*Cause*: An unsupported `getBytes()` or `setBytes()` JDBC method call was
+issued using a `BINARY`, `VARBINARY`, or `LONGVARBINARY` data type.
+
+*Effect*: `BINARY`, `VARBINARY`, and `LONGVARBINARY` data types are not supported.
+
+*Recovery*: Informational message only; no corrective action is needed.
+
+<<<
+=== 29018 22018
+
+```
+29018 2018 Invalid character value in cast specification
+```
+
+*Cause*: An attempt was made to convert a string to a numeric type but the
+string does not have the appropriate format.
+
+*Effect*: Strings that are obtained through a getter method cannot be cast
+to the method type.
+
+*Recovery*: Validate the string in the database to make sure it is a
+compatible type.
+
+=== 29019 07002
+
+```
+29019 07002 Parameter {0, number, integer} for {1, number, integer} set
+of parameters is not set.
+```
+
+*Cause*: An input descriptor contains a parameter that does not have a value set.
+
+*Effect*: The method `checkIfAllParamsSet()` reports the parameter that is not set.
+
+*Recovery*: Set a value for the listed parameter.
+
+=== 29020 07009
+
+```
+29020 07009 Invalid parameter index.
+```
+
+*Cause*: A getter or setter method parameter count index is outside of the
+valid input-descriptor range, or the input-descriptor range is null.
+
+*Effect*: The getter and setter method invocation validation fails.
+
+*Recovery*: Change the getter or setter parameter index to a valid parameter value.
+
+<<<
+=== 29021 HY004
+
+```
+29021 HY004 Object type not supported
+```
+
+*Cause*: A `PreparedStatement.setObject()` method call contains an unsupported Object Type.
+
+*Effect*: The `setObject()` method does not set a value for the designated parameter.
+
+*Recovery*: Informational message only; no corrective action is needed.
+Valid Object Types are: `null`, `BigDecimal`, `Date`, `Time`, `Timestamp`, `Double`,
+`Float`, `Long`, `Short`, `Byte`, `Boolean`, `String`, and `byte[]`, `Blob`, and `Clob`.
+
+=== 29022 HY010
+
+```
+29022 HY010 Function sequence error.
+```
+
+*Cause*: The `PreparedStatement.execute()` method does not support the use of
+the `PreparedStatement.addBatch()` method.
+
+*Effect*: An exception is reported; the operation is not completed.
+
+*Recovery*: Use the `PreparedStatement.executeBatch()` method.
+
+=== 29026 HY000
+
+```
+29026 HY000 Transaction can't be committed or rolled back when AutoCommitmode is on.
+```
+
+*Cause*: An attempt was made to commit a transaction while AutoCommit mode is enabled.
+
+*Effect*: The transaction is not committed.
+
+*Recovery*: Disable AutoCommit. Use the method only when the AutoCommit mode is disabled.
+
+<<<
+=== 29027 HY011
+
+```
+29027 HY011 SetAutoCommit not possible, since a transaction is active.
+```
+
+*Cause*: An attempt was made to call the `setAutoCommit()` mode while a transaction was active.
+
+*Effect*: The current AutoCommit mode is not modified.
+
+*Recovery*: Complete the transaction, then attempt to set the AutoCommit mode.
+
+=== 29029 HY011
+
+```
+29029 HY011 SetTransactionIsolation not possible, since a transaction is active.
+```
+
+*Cause*: An attempt was made to set transaction isolation level while a
+transaction was active.
+
+*Effect*: Attempts to change the transaction isolation level for this
+Connection object fail.
+
+*Recovery*: Complete the transaction, then attempt to set the transaction
+isolation level.
+
+=== 29031 HY000
+
+```
+29031 HY000 SQL SELECT statement in batch is illegal
+```
+
+*Cause*: A `SELECT SQL` statement was used in the `executeBatch()` method.
+
+*Effect*: An exception is reported; the `SELECT SQL` query cannot be used in batch queries.
+
+*Recovery*: Use the `executeQuery()` method to issue the `SELECT SQL` statement.
+
+<<<
+=== 29032 23000
+
+```
+29032 23000 Row has been modified since it is last read.
+```
+
+*Cause*: An attempt was made to update or delete a `ResultSet` object row while the cursor was on the insert row.
+
+*Effect*: The `ResultSet` row modification does not succeed.
+
+*Recovery*: Move the `ResultSet` object cursor away from the row before updating or deleting the row.
+
+=== 29033 23000
+
+```
+29033 23000 Primary key column value can't be updated.
+```
+
+*Cause*: An attempt was made to update the primary-key column in a table.
+
+*Effect*: The column is not updated.
+
+*Recovery*: Columns in the primary-key definition cannot be updated and
+cannot contain null values, even if you omit the NOT NULL clause in the
+column definition.
+
+=== 29035 HY000
+
+```
+29035 HY000IO Exception occurred {0}
+
+message_text
+```
+
+*Cause*: An ASCII or Binary or Character stream setter or an updater method
+resulted in a `java.io.IOException`.
+
+*Effect*: The designated setter or updater method does not modify the ASCII
+or Binary or Character stream.
+
+*Recovery*: Informational message only; no corrective action is needed.
+
+<<<
+=== 29036 HY000
+
+```
+29036 HY000 Unsupported encoding {0}
+```
+
+*Cause*: The character encoding is not supported.
+
+*Effect*: An exception is thrown when the requested character encoding is not supported.
+
+*Recovery*: `ASCII (ISO88591)`, `KANJI`, `KSC5601`, and `UCS2` are the only
+supported character encodings.
+
+=== 29037 HY106
+
+```
+29037 HY106 ResultSet type is TYPE_FORWARD_ONLY.
+```
+
+*Cause*: An attempt was made to point a `ResultSet` cursor to a previous row
+when the object type is set as `TYPE_FORWARD_ONLY`.
+
+*Effect*: The ResultSet object cursor manipulation does not occur.
+
+*Recovery*: `TYPE_FORWARD_ONLYResultSet` object type cursors can move forward
+only. `TYPE_SCROLL_SENSITIVE` and `TYPE_SCROLL_INSENSITIVE` types are
+scrollable.
+
+=== 29038 HY107
+
+```
+29038 HY107 Row number is not valid.
+```
+
+*Cause*: A `ResultSet` `absolute()` method was called when the row number was set to 0.
+
+*Effect*: The cursor is not moved to the specified row number.
+
+*Recovery*: Supply a positive row number (specifying the row number
+counting from the beginning of the result set), or supply a negative row
+number (specifying the row number counting from the end of the result set).
+
+<<<
+=== 29039 HY092
+
+```
+29039 HY092 Concurrency mode of the ResultSet is CONCUR_READ_ONLY.
+```
+
+*Cause*: An action was attempted on a `ResultSet` object that cannot be
+updated because the concurrency is set to `CONCUR_READ_ONLY`.
+
+*Effect*: The `ResultSet` object is not modified.
+
+*Recovery*: For updates, you must set the `ResultSet` object concurrency to `CONCUR_UPDATABLE`.
+
+=== 29040 HY000
+
+```
+29040 HY000 Operation invalid. Current row is the insert row.
+```
+
+*Cause*: An attempt was made to retrieve update, delete, or insert information on the current insert row.
+
+*Effect*: The `ResultSet` row information retrieval does not succeed.
+
+*Recovery*: To retrieve row information, move the `ResultSet` object cursor away from the insert row.
+
+=== 29041 HY000
+
+```
+29041 HY000 Operation invalid. No primary key for the table.
+```
+
+*Cause*: The `getKeyColumns()` method failed on a table that was created without a primary-key column defined.
+
+*Effect*: No primary-key data is returned for the table.
+
+*Recovery*: Change the table to include a primary-key column.
+
+<<<
+=== 29042 HY000
+
+```
+29042 HY000 Fetch size value is not valid.
+```
+
+*Cause*: An attempt was made to set the fetch-row size to a value that is less than 0.
+
+*Effect*: The number of rows that are fetched from the database when more rows are needed is not set.
+
+*Recovery*: For the `setFetchSize()` method, supply a valid row value that is greater than or equal to 0.
+
+=== 29043 HY000
+
+```
+29043 HY000 Max rows value is not valid.
+```
+
+*Cause*: An attempt was made to set a limit of less than 0 for the maximum
+number of rows that any `ResultSet` object can contain.
+
+*Effect*: The limit for the maximum number of rows is not set.
+
+*Recovery*: For the `setMaxRows()` method, use a valid value that is greater than or equal to 0.
+
+=== 29044 HY000
+
+```
+29044 HY000 Query timeout value is not valid.
+```
+
+*Cause*: An attempt was made to set a value of less than 0 for the number
+of seconds the driver waits for a Statement object to execute.
+
+*Effect*: The query timeout limit is not set.
+
+*Recovery*: For the `setQueryTimeout()` method, supply a valid value that is
+greater than or equal to 0.
+
+<<<
+=== 29045 01S07
+
+```
+29045 01S07 Fractional truncation.
+```
+
+*Cause*: The data retrieved by the `ResultSet` getter method has been truncated.
+
+*Effect*: The data retrieved is truncated.
+
+*Recovery*: Make sure that the data to be retrieved is within a valid data-type range.
+
+=== 29046 22003
+
+```
+29046 22003 Numeric value out of range.
+```
+
+*Cause*: A value retrieved from the ResultSet getter method is outside the range for the data type.
+
+*Effect*: The ResultSet getter method does not retrieve the data.
+
+*Recovery*: Make sure the data to be retrieved is within a valid data-type range.
+
+=== 29047 HY000
+
+```
+29047 HY000 Batch update failed. See next exception for details.
+```
+
+*Cause*: One of the commands in a batch update failed to execute properly.
+
+*Effect*: Not all the batch-update commands succeed. See the subsequent
+exception for more information.
+
+*Recovery*: View the subsequent exception for possible recovery actions.
+
+<<<
+=== 29048 HY009
+
+```
+29048 HY009 Invalid use of null.
+```
+
+*Cause*: A parameter that has an expected table name is set to null.
+
+*Effect*: The `DatabaseMetadata` method does not report any results.
+
+*Recovery*: For the `DatabaseMetaData` method, supply a valid table name that is not null.
+
+=== 29049 25000
+
+```
+29049 25000 Invalid transaction state.
+```
+
+*Cause*: The `begintransaction()` method was called when a transaction was in progress.
+
+*Effect*: A new transaction is not started.
+
+*Recovery*: Before calling the `begintransaction()` method, validate whether
+other transactions are currently started.
+
+=== 29050 HY107
+
+```
+29050 HY107 Row value out of range.
+```
+
+*Cause*: A call to `getCurrentRow` retrieved is outside the first and last row range.
+
+*Effect*: The current row is not retrieved.
+
+*Recovery*: It is an informational message only; no recovery is needed.
+Contact {project-support} and report the entire message.
+
+<<<
+=== 29051 01S02
+
+```
+29051 01S02 ResultSet type changed to TYPE_SCROLL_INSENSITIVE.
+```
+*Cause*: The Result Set Type was changed.
+
+*Effect*: None.
+
+*Recovery*: This message is reported as an SQL Warning. It is an informational message only; no recovery is needed.
+
+=== 29053 HY000
+
+```
+29053 HY000 SQL SELECT statement is invalid in executeUpdate() methodCause.
+```
+
+*Cause*: A select SQL statement was used in the `executeUpdate()` method.
+
+*Effect*: The SQL query not performed exception is reported.
+
+*Recovery*: Use the `executeQuery()` method to issue the select SQL statement.
+
+=== 29054 HY000
+
+```
+29054 HY000 Only SQL SELECT statements are valid in executeQuery() method.
+```
+
+*Cause*: A non-select SQL statement was used in the `executeQuery()` method.
+
+*Effect*: The exception reported is "SQL query not performed".
+
+*Recovery*: Use the `executeUpdate()` method to issue the non-select SQL statement.
+
+<<<
+=== 29056 HY000
+
+```
+29056 HY000 Statement is already closed.
+```
+
+*Cause*: A `validateSetInvocation()` or `validateExecuteInvocation` method was used on a closed statement.
+
+*Effect*: The validation on the statement fails and returns an exception.
+
+*Recovery*: Use the `validateSetInvocation()` or `validateExecuteInvocation` method prior to the statement close.
+
+
+=== 29057 HY000
+
+```
+29057 HY000 Auto generated keys not supported.
+```
+
+*Cause*: An attempt was made to use the Auto-generated keys feature.
+
+*Effect*: The attempt does not succeed.
+
+*Recovery*: The Auto-generated keys feature is not supported.
+
+=== 29058 HY000
+
+```
+29058 HY000 Connection is not associated with a PooledConnection object.
+```
+
+*Cause*: The `getPooledConnection()` method was invoked before the `PooledConnection` object was established.
+
+*Effect*: A connection from the pool cannot be retrieved.
+
+*Recovery*: Make sure a `PooledConnection` object is established before using
+the `getPooledConnection()` method.
+
+<<<
+=== 29059 HY000
+
+```
+29059 HY000 'blobTableName' property is not set or set to null value or set to invalid value.
+```
+
+*Cause*: Attempted to access a BLOB column without setting the property
+`hpt4jdbc.blobTableName`, or the property is set to an invalid value.
+
+*Effect*: The application cannot access BLOB columns.
+
+*Recovery*: Set the `hpt4jdbc.blobTableName` property to a valid LOB table
+name. The LOB table name is of format `catalog.schema.lobTableName`.
+
+=== 29060 HY000
+
+```
+29060 HY000 'hpt4jdbc.clobTableName' property is not set or set to null value or set to invalid value.
+```
+
+*Cause*: Attempted to access a CLOB column without setting the
+`propertyhpt4jdbc.clobTableName` property, or the property is set to null
+value or set to an invalid value.
+
+*Effect*: The application cannot access CLOB columns.
+
+*Recovery*: Set the `hpt4jdbc.clobTableName` property to a valid LOB table
+name. The LOB table name is of format `catalog.schema.lobTableName`.
+
+=== 29061 HY00
+
+```
+29061 HY00 Lob object {0} is not current.
+```
+
+*Cause*: Attempted to access LOB column data after the cursor moved or the
+result set from which the LOB data was obtained had been closed.
+
+*Effect*: The application cannot access LOB data.
+
+*Recovery*: Read the LOB data before moving the cursor or closing the result-set object.
+
+<<<
+=== 29063 HY00
+
+```
+29063 HY00 Transaction error {0} - {1} while obtaining start data locator.
+```
+
+*Cause*: A transaction error occurred when the Type 4 driver attempted to
+reserve the data locators for the given process while inserting or
+updating a LOB column.
+
+*Effect*: The application cannot insert or update the LOB columns.
+
+*Recovery*: Check the file-system error in the message and take recovery action accordingly.
+
+=== 29067 07009
+
+```
+2067 07009 Invalid input value in the method {0}.
+```
+
+*Cause*: One or more input values in the given method is invalid.
+
+*Effect*: The given input method failed.
+
+*Recovery*: Check the input values for the given method.
+
+=== 29068 07009
+
+```
+29068 07009 The value for position can be any value between 1 and one more than the length of the LOB data.
+```
+
+*Cause*: The position input value in `Blob.setBinaryStream`,
+`Clob.setCharacterStream`, or `Clob.setAsciiStream` can be between 1 and one
+more than the length of the LOB data.
+
+*Effect*: The application cannot write the LOB data at the specified position.
+
+*Recovery*: Correct the position input value.
+
+<<<
+=== 29069 HY000
+
+```
+29069 HY000 Autocommit is on and LOB objects are involved.
+```
+
+*Cause*: An attempt was made to access a LOB column when autocommit made is enabled.
+
+*Effect*: The application cannot access LOB columns.
+
+*Recovery*: Disable the autocommit mode.
+
+=== 29100 HY000
+
+```
+29100 HY000 An internal error occurred.
+```
+
+*Cause*: Internal error.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+=== 29101 HY000
+
+```
+29101 HY000 Contact your service provider.
+```
+
+*Cause*: Internal error.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} (the service provider) and report the entire message.
+
+<<<
+=== 29102 HY000
+
+```
+29101 HY000 Error while parsing address <address>.
+```
+*Cause*: The address format was not recognized.
+
+*Effect*: Operation fails.
+
+*Recovery*: Refer to <<url, url Property>> for the valid address format.
+
+=== 29103 HY000
+
+```
+29103 HY000 Address is null.
+```
+
+*Cause*: The address was empty.
+
+*Effect*: Operation fails.
+
+*Recovery*: Refer to <<url, url Property>> for the valid address format.
+
+=== 29104 HY000
+
+```
+29104 HY000 Expected suffix: <suffix>.
+```
+
+*Cause*: The address suffix was incorrect or missing.
+
+*Effect*: Operation fails.
+
+*Recovery*: Refer to <<url, url Property>> for the valid address format.
+
+<<<
+=== 29105 HY000
+
+```
+29105 HY000 Unknown prefix for address.
+```
+
+*Cause*: The address prefix was incorrect or missing.
+
+*Effect*: Operation fails.
+
+*Recovery*: Refer to <<url, url Property>> for the valid address format.
+
+=== 29106 HY000
+
+```
+29016 HY000 Expected address format: jdbc:subprotocol::subname.
+```
+
+*Cause*: Not applicable.
+
+*Effect*: Not applicable.
+
+*Recovery*: This is an informational message.
+Refer to <<url, url Property>> for the valid address format.
+
+=== 29107 HY000
+
+```
+29107 HY000 Address not long enough to be a valid address.
+```
+
+*Cause*: The address length was too short to be a valid address.
+
+*Effect*: Operation fails.
+
+*Recovery*: Refer to <<url, url Property>> for the valid address format.
+
+<<<
+=== 29108 HY000
+
+```
+29108 HY000 Expecting \\<machine-name><process-name>/<port-number>.
+```
+
+*Cause*: The DCS address format was invalid.
+
+*Effect*: Operation fails.
+
+*Recovery*: The address returned by the {project-name} platform was not in
+the expected format. Contact {project-support} and report the entire message.
+
+=== 29109 HY000
+
+```
+29109 HY000 //<{IP Address|Machine Name}[:port]/database name>
+```
+
+*Cause*: Informational message.
+
+*Effect*: Not applicable.
+
+*Recovery*: Not applicable.
+
+=== 29110 HY000
+
+```
+29110 HY000 Address is missing an IP address or machine name.
+```
+
+*Cause*: An IP address or machine name is required, but missing.
+
+*Effect*: The operation fails.
+
+*Recovery*: Include a valid IP address or machine name.
+Refer to <<url, url Property>> for the valid address format.
+
+<<<
+=== 29111 HY000
+
+```
+29111 HY000 Unable to evaluate address <address> Cause: <cause>.
+```
+*Cause*: The driver could not determine the IP address for a host.
+
+*Effect*: The operation fails.
+
+*Recovery*: The address or machine name may not be properly qualified or
+there my exist a security restriction. See the documentation for the
+`getAllByName` method in the `java.net.InetAddress` class. Include a valid
+IP address or machine name. Refer to <<url, url Property>> for the
+valid address format.
+
+
+=== 29112 HY000
+
+```
+29112 HY000 Missing ']'.
+```
+
+*Cause*: The driver could not determine the IP address for a host.
+
+*Effect*: The operation fails.
+
+*Recovery*: The address or machine name may not be properly formatted.
+Refer to <<url, url Property>> for the valid address format.
+
+=== 29113 HY000
+
+```
+29113 HY000 Error while opening socket. Cause: <cause>.
+```
+
+*Cause*: Socket error.
+
+*Effect*: The operation fails.
+
+*Recovery*: Use the `getCause` method on the `Exception` to determine the
+appropriate recovery action.
+
+<<<
+=== 29114 HY000
+
+```
+29114 HY000 Error while writing to socket.
+```
+
+*Cause*: Socket write error.
+
+*Effect*: The operation fails.
+
+*Recovery*: Use the `getCause` method on the `Exception` to determine the
+appropriate recovery action.
+
+
+
+=== 29115 HY000
+
+```
+29115 HY000 Error while reading from socket. Cause: <cause>.
+```
+
+*Cause*: Socket read error.
+
+*Effect*: The operation fails.
+
+*Recovery*: Use the `getCause` method on the `Exception` to determine the
+appropriate recovery action.
+
+=== 29116 HY000
+
+```
+29116 HY000 Socket is closed.
+```
+
+*Cause*: Socket close error.
+
+*Effect*: The operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29117 HY000
+
+```
+29117 HY000 Error while closing session. Cause: <cause>.
+```
+
+*Cause*: An error was encountered while closing a session.
+
+*Effect*: The operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29118 HY000
+
+```
+29118 HY000 A write to a bad map pointer occurred.
+```
+
+*Cause*: Internal error.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+=== 29119 HY000
+
+```
+29119 HY000 A write to a bad par pointer occurred.
+```
+
+*Cause*: Internal error.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+<<<
+=== 29120 HY000
+
+```
+29120 HY000 An association server connect message error occurred.
+```
+
+*Cause*: Unable to connect to the DCS association server.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29121 HY000
+
+```
+29121 HY000 A close message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+=== 29122 HY000
+
+```
+29122 HY000 An end transaction message error occurred.
+```
+
+*Cause*: Unable to perform the operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29123 HY000
+
+```
+29123 HY000 An execute call message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29124 HY000
+
+```
+29124 HY000 An execute direct message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29125 HY000
+
+```
+29125 HY000 An execute direct rowset message error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+<<<
+=== 29126 HY000
+
+```
+29126 HY000 An execute N message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+
+=== 29127 HY000
+
+```
+29127 HY000 An execute rowset message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29128 HY000
+
+```
+29128 HY000 A fetch perf message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29129 HY000
+
+```
+29129 HY000 A fetch rowset message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29130 HY000
+
+```
+29130 HY000 A get sql catalogs message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29131 HY000
+
+```
+29131 HY000 An initialize dialogue message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+<<<
+=== 29132 HY000
+
+```
+29132 HY000 A prepare message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29133 HY000
+
+```
+29133 HY000 A prepare rowset message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+=== 29134 HY000
+
+```
+29134 HY000 A set connection option message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29135 HY000
+
+```
+29135 HY000 A terminate dialogue message error occurred. Cause: <cause>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+
+=== 29136 HY000
+
+```
+29136 HY000 An association server connect reply occurred.
+Exception: <exception> Exception detail: <exception_detail>
+Error text/code: <error text or code>.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate any error or error detail information accompanying
+this message and contact {project-support} to check logs for server
+({project-name} platform) errors and to analyze accompanying errors and
+warnings.
+
+=== 29137 HY000
+
+```
+29137 HY000 A close reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29138 HY000
+
+```
+29138 HY000 An end transaction reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29139 HY000
+
+```
+29139 HY000 An execute call reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+=== 29140 HY000
+
+```
+29140 HY000 An execute direct reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29141 HY000
+
+```
+29141 HY000 An execute direct rowset reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29142 HY000
+
+```
+29142 HY000 An execute N reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+=== 29143 HY000
+
+```
+29143 HY000 An execute rowset reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29144 HY000
+
+```
+29144 HY000 A fetch perf reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29145 HY000
+
+```
+29145 HY000 A fetch rowset reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+=== 29146 HY000
+
+```
+29146 HY000 A get sql catalogs reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29147 HY000
+
+```
+29147 HY000 An initialize dialogue reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29148 HY000
+
+```
+29148 HY000 A prepare reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+=== 29149 HY000
+
+```
+29149 HY000 A prepare rowset reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29150 HY000
+
+```
+29150 HY000 A set connection option reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+
+=== 29151 HY000
+
+```
+29151 HY000 A terminate dialogue reply error occurred.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate the returned value from the `getCause` method on the
+`Exception` to determine the appropriate recovery action.
+
+=== 29152 HY000
+
+```
+29152 HY000 No more ports available to start ODBC servers.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+
+*Recovery*: Contact {project-support} to check logs for server ({project-name}
+platform) errors. Evaluate the returned value from the `getCause` method
+on the `Exception` to determine the appropriate recovery action.
+
+<<<
+=== 29153 HY000
+
+```
+29153 HY000 Invalid authorization specification.
+```
+
+*Cause*: Incorrect user name and/or password.
+
+*Effect*: Operation fails.
+
+*Recovery*: Retry with correct user name and/or password.
+
+
+=== 29154 HY000
+
+```
+29154 HY000 Timeout expired.
+```
+
+*Cause*: Unable to perform this operation.
+
+*Effect*: Operation fails.
+
+*Recovery*: Retry and/or change the timeout value for the operation.
+
+=== 29155 HY000
+
+```
+29155 HY000 Unknown message type.
+```
+
+*Cause*: Internal error.
+
+*Effect*: Operation fails.
+
+*Recovery*: Contact {project-support} to check logs for server ({project-name}
+platform) errors and to analyze errors and warnings.
+
+<<<
+=== 29156 HY000
+
+```
+29156 HY000 An error was returned from the server. Error: <error>
+Error detail: <error_detail>.
+```
+
+*Cause*: The server reported an error.
+
+*Effect*: Operation fails.
+
+
+*Recovery*: Evaluate any error or error detail information accompanying the
+message. Contact {project-support} to check logs for server ({project-name}
+platform) errors and to analyze accompanying errors and warnings.
+
+
+=== 29157 HY000
+
+```
+29157 HY000 There was a problem reading from the server.
+```
+
+*Cause*: The server reported an error.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate any error or error detail information accompanying the
+message. Contact {project-support} to check logs for server ({project-name}
+platform) errors and to analyze accompanying errors and warnings.
+
+=== 29158 HY000
+
+```
+29158 HY000 The message header contained the wrong version.
+Expected: <expected_version> Actual: <actual_version>.
+```
+
+*Cause*: The server's version differs from the expected version.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate any error or error detail information accompanying the
+message. Install compatible versions of the driver and HP connectivity
+server.
+
+<<<
+=== 29159 HY000
+
+```
+29159 HY000 The message header contained the wrong signature.
+Expected: <expected_signature> Actual: <actual_signature>.
+```
+
+*Cause*: The server's signature differs from the expected version.
+
+*Effect*: Operation fails.
+
+*Recovery*: Evaluate any error or error detail information accompanying the
+message. Install compatible versions of the driver and HP connectivity
+server.
+
+
+=== 29160 HY000
+
+```
+29160 HY000 The message header was not long enough.
+```
+
+*Cause*: The message returned by the server was too short to be a valid message.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+=== 29161 S1000
+
+```
+29161 S1000 Unable to authenticate the user because of an NT error: {0}
+```
+
+*Cause*: A message returned by the server.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+<<<
+=== 29162 S1000
+
+```
+29162 S1000 Unexpected programming exception has been found: <exception>.
+```
+
+Check the server event log on node _node_ for details.
+
+*Cause*: A message returned by the server.
+
+*Effect*: Operation fails.
+
+*Recovery*: Contact {project-support} to check logs for server ({project-name}
+platform) errors and to analyze accompanying errors and warnings.
+
+
+=== 29163 08001
+
+```
+29163 08001 ODBC Services not yet available: <server>.
+```
+
+*Cause*: A message returned by the server.
+
+*Effect*: Operation fails.
+
+*Recovery*: Retry and/or wait for a server to become available. Configure
+server-side data source with more servers.
+
+=== 29164 08001
+
+```
+29164 08001 DataSource not yet available or not found: <error>.
+```
+
+*Cause*: A message returned by the server.
+
+*Effect*: Operation fails.
+
+*Recovery*: Create server data source and/or configure server data source
+with more servers.
+
+<<<
+=== 29165 HY000
+
+```
+29165 HY000 Unknown connect reply error: <error>.
+```
+
+*Cause*: A message returned by the server.
+
+*Effect*: Operation fails.
+
+*Recovery*: Contact {project-support} to check logs for server ({project-name}
+platform) errors and to analyze accompanying errors and warnings.
+
+
+=== 29166 HY000
+
+```
+29166 HY000 This method is not implemented.
+```
+
+*Cause*: Internal error.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+=== 29167 HY000
+
+```
+29167 HY000 Internal error. An internal index failed consistency check.
+```
+
+*Cause*: Internal error.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+<<<
+=== 29168 HY000
+
+```
+29168 HY000 Unknown reply message error: <error> error detail: <error_detail>.
+```
+
+*Cause*: Server returned an error.
+
+*Effect*: Operation fails.
+
+*Recovery*: Contact {project-support} to check logs for server ({project-name}
+platform) errors and to analyze accompanying errors and warnings.
+
+
+=== 29169 HY000
+
+```
+29169 HY000 Invalid connection property setting
+```
+
+*Cause*: The message returned by the server was too short to be a valid message.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+=== 29170 HY000
+
+```
+29170 HY000 Invalid parameter value.
+```
+
+*Cause*: Internal error.
+
+*Effect*: Operation fails.
+
+*Recovery*: None. Contact {project-support} and report the entire message.
+
+<<<
+=== 29172 HY000
+
+```
+29172 HY000 Translation of parameter to {0} failed.
+```
+
+*Cause*: Translation errors occurred when translating the parameter into
+the target character set reported in the {0} replacement variable.
+
+*Effect*: The method fails.
+
+*Recovery*: Set the parameter to use characters within the appropriate
+character set. You can also turn off translation validation by setting
+the `translationVerification` property to FALSE.
+
+
+=== 29173 HY000
+
+```
+29173 HY000 Translation of SQL statement {0} failed.
+```
+
+*Cause*: Translation errors occurred when translating the SQL statement
+into the target character set reported in the {0} replacement
+variable.
+
+*Effect*: The method fails.
+
+*Recovery*: Edit the SQL statement to use characters within the appropriate
+character set. You can also turn off translation validation by setting
+the `translationVerification` property to FALSE.
+
+=== 29174 HY000
+
+```
+29174 HY000 Autocommit is on and updateRow was called on the ResultSetobject.
+```
+
+*Cause*: The `ResultSet.updateRow()` method is called when autocommit is set on.
+
+*Effect*: Warning is thrown. Subsequent `ResultSet.next()` calls will fail
+because all the `ResultSet(cursors)` are closed.
+
+*Recovery*: Call the `ResultSet.updateRow()` method with autocommit set to off.
+
+<<<
+=== 29175 HY000
+
+```
+29175 HY000 Unknown Error {0}.
+```
+
+*Cause*: An unknown error occurred during connection {0}.
+
+*Effect*: The connection fails.
+
+*Recovery*: Retry the connection.
+
+
+=== 29177 HY000
+
+```
+29177 HY000 Data cannot be null.
+```
+
+*Cause*: Attempted to get column value data in String format, but passed a null input value.
+
+*Effect*: The operation fails.
+
+*Recovery*: Contact {project-support} to check logs for server ({project-name}
+platform) errors regarding the DCS server.
+
+=== 29178 HY000
+
+```
+29178 HY000 No column value has been inserted.
+```
+
+*Cause*: The value for a required column was not specified.
+
+*Effect*: Operation fails.
+
+*Recovery*: Ensure that all required column values are specified, and retry
+the operation.
+
+<<<
+=== 29182 HY000
+
+```
+29182 HY000 General warning. Connected to the default data source:
+TDM_Default_DataSource
+```
+
+*Cause*: The user application specified a data source that does not exist
+on the server side, the {project-name} platform.
+
+*Effect*: The connection uses the {project-name} platform default data
+source `TDM_Default_DataSource`.
+
+*Recovery*: Ignore the warning or contact your {project-name} database
+administrator to add the server-side data source that the application
+specified.
+
+
+=== S1000 HY000
+
+```
+S1000 HY000 A TIP transaction error <error> has been detected. Check the
+server event log on Node <segment> for Transaction Error details.
+```
+
+*Cause*: A message was returned by the server.
+
+*Effect*: Operation fails.
+
+*Recovery*: Contact {project-support} to check for errors in the server event log
+on the reported segment.
+
[12/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/prepare.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/prepare.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/prepare.adoc
index 2df5383..b9f63c4 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/prepare.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/prepare.adoc
@@ -20,12 +20,12 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[prepare]]
= Prepare
-You need to prepare your Hadoop environment before installing Trafodion.
+You need to prepare your Hadoop environment before installing {project-name}.
1. <<prepare-install-optional-workstation-software,Install Optional Workstation Software>>
2. <<configure-installation-user-id,Configure Installation User ID>>
@@ -40,7 +40,7 @@ You need to prepare your Hadoop environment before installing Trafodion.
== Install Optional Workstation Software
If you are using a Windows workstation, then the following optional software helps installation process.
-We recommended that you pre-install the software before continuing with the Trafodion installation:
+We recommended that you pre-install the software before continuing with the {project-name} installation:
* putty and puttygen (download from http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html[PuTTY web site])
* VNC client (download from http://www.realvnc.com[RealVNC web site])
@@ -50,10 +50,10 @@ We recommended that you pre-install the software before continuing with the Traf
[[configure-installation-user-id]]
== Configure Installation User ID
-Trafodion installation requires a user ID with these attributes:
+{project-name} installation requires a user ID with these attributes:
* `sudo` access per the requirements documented in <<requirements-linux-installation-user,Linux Installation User>>.
-* passwordless ssh to all nodes on the cluster where Trafodion will be installed.
+* passwordless ssh to all nodes on the cluster where {project-name} will be installed.
NOTE: You may need to request permission from your cluster-management team to obtain this type of access.
@@ -91,15 +91,15 @@ ensure that the `requiretty` option is NOT being used.
== Verify OS Requirements and Recommendations
Please ensure that the <<requirements-os-requirements-and-recommendations,OS Requirements and Recommendations>>
-are met for each node in the cluster where you intend to install Trafodion.
+are met for each node in the cluster where you intend to install {project-name}.
<<<
[[prepare-configure-ldap-identity-store]]
== Configure LDAP Identity Store
-If you plan to enable security in Trafodion, then you need to have an LDAP identity store available to perform authentication.
-The Trafodion Installer prompts you to set up an authentication configuration file that points to an LDAP server (or servers),
-which enables security (that is, authentication and authorization) in the Trafodion database.
+If you plan to enable security in {project-name}, then you need to have an LDAP identity store available to perform authentication.
+The {project-name} Installer prompts you to set up an authentication configuration file that points to an LDAP server (or servers),
+which enables security (that is, authentication and authorization) in the {project-name} database.
If you wish to manually set up the authentication configuration file and enable security, then refer to the section on
<<enable-security,Enable Security>>.
@@ -107,7 +107,7 @@ If you wish to manually set up the authentication configuration file and enable
[[prepare-gather-configuration-information]]
== Gather Configuration Information
-You need to gather/decide information about your environment to aid installation Trafodion, both for the Trafodion Installer
+You need to gather/decide information about your environment to aid installation {project-name}, both for the {project-name} Installer
and for recipe-based provisioning. (Listed in alphabetical order to make it easier to find information when referenced in the install and upgrade instructions.)
[cols="25%l,25%,15%l,35%",options="header"]
@@ -116,27 +116,27 @@ and for recipe-based provisioning. (Listed in alphabetical order to make it easi
| ADMIN | Administrator user name for Apache Ambari or Cloudera Manager. | admin | A user that can change configuration and restart services via the
distribution manager's REST API.
| BACKUP_DCS_NODES | List of nodes where to start the backup DCS Master components. | None | Blank separated FQDN list. Not needed if $ENABLE_HA = N.
-| CLOUD_CONFIG | Whether you're installing Trafodion on a cloud environment. | N | N = bare-metal or VM installation.
-| CLOUD_TYPE | What type of cloud environment you're installing Trafodion on. | None | { AWS \| OpenStack \| Other }. Not applicable for bare-metal or VM installation.
+| CLOUD_CONFIG | Whether you're installing {project-name} on a cloud environment. | N | N = bare-metal or VM installation.
+| CLOUD_TYPE | What type of cloud environment you're installing {project-name} on. | None | { AWS \| OpenStack \| Other }. Not applicable for bare-metal or VM installation.
| CLUSTER_NAME | The name of the Hadoop Cluster. | None | From Apache Ambari or Cloudera Manager.
-| DCS_BUILD | Tar file containing the DCS component. | None | Not needed if using a Trafodion package installation tar file.
+| DCS_BUILD | Tar file containing the DCS component. | None | Not needed if using a {project-name} package installation tar file.
| DCS_PRIMARY_MASTER_NODE | The node where the primary DCS should run. | None | The DCS Master handles JDBC and ODBC connection requests.
| DCS_SERVER_PARM | Number of concurrent client sessions per node. | 16 | This number specifies the concurrent sessions per node to be supported. Each session could require up to 1GB of physical memory. The number can be changed post-installation. For more information,
-refer to the http://trafodion.apache.org/docs/client_install/index.html[Trafodion Client Installation Guide].
+refer to the {docs-url}/client_install/index.html[{project-name} Client Installation Guide].
| ENABLE_HA | Whether to run DCS in high-availability (HA) mode. | N | You need the floating IP address, the interface, and the backup nodes for DCS Master if enabling this feature.
| EPEL_RPM | Location of EPEL RPM. | None | Specify if you don't have access to the Internet.
-Downloaded automatically by the Trafodion Installer.
+Downloaded automatically by the {project-name} Installer.
| FLOATING_IP | IP address if running DCS in HA mode. | None | Not needed if $ENABLE_HA = N. An FQDN name or IP address.
-| HADOOP_TYPE | The type of Hadoop distribution you're installing Trafodion on. | None | Lowercase. cloudera or hadoop.
+| HADOOP_TYPE | The type of Hadoop distribution you're installing {project-name} on. | None | Lowercase. cloudera or hadoop.
| HBASE_GROUP | Linux group name for the HBASE administrative user. | hbase | Required in order to provide access to select HDFS directories to this user ID.
| HBASE_USER | Linux user name for the HBASE administrative user. | hbase | Required in order to provide access to select HDFS directories to this user ID.
-| HDFS_USER | Linux user name for the HDFS administrative user. | hdfs | The Trafodion Installer uses `sudo su` to make HDFS
+| HDFS_USER | Linux user name for the HDFS administrative user. | hdfs | The {project-name} Installer uses `sudo su` to make HDFS
configuration changes under this user.
| HOME_DIR | Root directory under which the `trafodion` home directory should be created. | /home | *Example* +
+
If the home directory of the `trafodion` user is
`/opt/home/trafodion`, then specify the root directory as `/opt/home`.
-| INIT_TRAFODION | Whether to automatically initialize the Trafodion database. | N | Does not apply to Recipe-Based Provisioning. Applies if $START=Y only.
+| INIT_TRAFODION | Whether to automatically initialize the {project-name} database. | N | Does not apply to Recipe-Based Provisioning. Applies if $START=Y only.
| INTERFACE | Interface type used for $FLOATING_IP. | None | Not needed if $ENABLE_HA = N.
| JAVA_HOME | Location of Java 1.7.0_65 or higher (JDK). | $JAVA_HOME setting | Fully qualified path of the JDK. For example:
`/usr/java/jdk1.7.0_67-cloudera`
@@ -148,27 +148,27 @@ If the home directory of the `trafodion` user is
| LDAP_PORT^2^ | Port used to communicate with LDAP Identity Store. | None | Examples: 389 for no encryption or TLS, 636 for SSL.
| LDAP_SECURITY^2^ | Whether to enable simple LDAP authentication. | N | If Y, then you need to provide LDAP_HOSTS.
| LDAP_USER^2^ | LDAP Search user name. | None | If required. If so, must provide LDAP_PASSWORD, too.
-| LOCAL_WORKDIR | The directory where the Trafodion Installer is located. | None | Full path, no environmental variables.
+| LOCAL_WORKDIR | The directory where the {project-name} Installer is located. | None | Full path, no environmental variables.
| MANAGEMENT_ENABLED | Whether your installation uses separate management nodes. | N | Y if using separate management nodes for Apache Ambari or Cloudera Manager.
| MANAGEMENT_NODES | The FQDN names of management nodes, if any. | None | Provide a blank-separated list of node names.
-| NODE_LIST | The FQDN names of the nodes where Trafodion will be installed. | None | Provide a blank-separated list of node names. The Trafodion
+| NODE_LIST | The FQDN names of the nodes where {project-name} will be installed. | None | Provide a blank-separated list of node names. The {project-name}
Provisioning ID must have passwordless and `sudo` access to these nodes.
| PASSWORD | Administrator password for Apache Ambari or Cloudera Manager. | admin | A user that can change configuration and restart services via the
distribution manager's REST API.
-| REST_BUILD | Tar file containing the REST component. | None | Not needed if using a Trafodion package installation tar file.
-| SQ_ROOT | Target directory for the Trafodion software. | $HOME_DIR/trafodion | Trafodion is installed in this directory on all nodes in `$NODE_LIST`.
-| START | Whether to start Trafodion after install/upgrade. | N | Does not apply to Recipe-Based Provisioning.
-| SUSE_LINUX | Whether your installing Trafodion on SUSE Linux. | false | Auto-detected by the Trafodion Installer.
-| TRAF_PACKAGE | The location of the Trafodion installation package tar file or core installation tar file. | None | The package file contains the Trafodion server,
-DCS, and REST software while the core installation file contains the Trafodion server software only. If you're using a core installation file, then you need to
-record the location of the DCS and REST installation tar files, too. Normally, you perform Trafodion provisioning using a Trafodion package installation tar file.
-| TRAF_USER | The Trafodion runtime user ID. | trafodion | Must be `trafodion` in this release.
+| REST_BUILD | Tar file containing the REST component. | None | Not needed if using a {project-name} package installation tar file.
+| SQ_ROOT | Target directory for the {project-name} software. | $HOME_DIR/trafodion | {project-name} is installed in this directory on all nodes in `$NODE_LIST`.
+| START | Whether to start {project-name} after install/upgrade. | N | Does not apply to Recipe-Based Provisioning.
+| SUSE_LINUX | Whether your installing {project-name} on SUSE Linux. | false | Auto-detected by the {project-name} Installer.
+| TRAF_PACKAGE | The location of the {project-name} installation package tar file or core installation tar file. | None | The package file contains the {project-name} server,
+DCS, and REST software while the core installation file contains the {project-name} server software only. If you're using a core installation file, then you need to
+record the location of the DCS and REST installation tar files, too. Normally, you perform {project-name} provisioning using a {project-name} package installation tar file.
+| TRAF_USER | The {project-name} runtime user ID. | trafodion | Must be `trafodion` in this release.
| TRAF_USER_PASSWORD | The password used for the `trafodion:trafodion` user ID. | traf123 | Must be 6-8 characters long.
| URL | FQDN and port for the Distribution Manager's REST API. | None | Include `http://` or `https://` as applicable. Specify in the form:
`<IP-address>:<port>` or `<node name>:<port>` Example: `https://susevm-1.yourcompany.local:8080`
|===
-1. The ID matches the environmental variables used in the Trafodion Installation configuration file. Refer to <<install-trafodion-installer,Trafodion Installer>>
+1. The ID matches the environmental variables used in the {project-name} Installation configuration file. Refer to <<install-trafodion-installer,{project-name} Installer>>
for more information.
2. Refer to <<enable-security,Enable Security>> for more information about these security settings.
@@ -182,11 +182,11 @@ for more information.
This step is required if you're:
-* Installing Trafodion on SUSE.
+* Installing {project-name} on SUSE.
* Using Recipe-Based Provisioning.
* Can't download the required software packages using the Internet.
-If none of these situations exist, then we highly recommend that you use the Trafodion Installer.
+If none of these situations exist, then we highly recommend that you use the {project-name} Installer.
You perform this step as a user with `root` or `sudo` access.
@@ -201,7 +201,7 @@ You perform this step as a user with `root` or `sudo` access.
This step is required regardless of the <<introduction-provisioning-options,Provisioning Options>> used.
-1. Download the log4c++ RPM from the Trafodion http://trafodion.incubator.apache.org/download.html[Download] page.
+1. Download the log4c++ RPM from the {project-name} {download-url}[Download] page.
2. Copy and Install the log4c++ RPM on All Nodes
+
@@ -231,16 +231,16 @@ log4cxx-0.10.0-13.el6.x86_64
```
[[prepare-download-trafodion-binaries]]
-== Download Trafodion Binaries
+== Download {project-name} Binaries
-You download the Trafodion binaries from the Trafodion http://trafodion.apache.org/download.html[Download] page.
+You download the {project-name} binaries from the {project-name} {download-url}[Download] page.
Download the following packages:
-* Trafodion Installer (if planning to use the Trafodion Installer)
-* Trafodion Server
+* {project-name} Installer (if planning to use the {project-name} Installer)
+* {project-name} Server
-NOTE: You can download and install the Trafodion Clients once you've installed and activated Trafodion. Refer to the
-http://trafodion.apache.org/docs/client_install/index.html[Trafodion Client Install Guide] for instructions.
+NOTE: You can download and install the {project-name} Clients once you've installed and activated {project-name}. Refer to the
+{docs-url}/client_install/index.html[{project-name} Client Install Guide] for instructions.
*Example*
@@ -249,7 +249,7 @@ http://apache.cs.utah.edu/incubator/celix/celix-1.0.0.incubating/celix-1.0.0.inc
```
$ mkdir $HOME/trafodion-download
$ cd $HOME/trafodion-download
-$ Download the Trafodion Installer binaries
+$ Download the {project-name} Installer binaries
$ wget http://apache.cs.utah.edu/incubator/trafodion/trafodion-1.3.0.incubating/apache-trafodion-installer-1.3.0-incubating-bin.tar.gz
Resolving http://apache.cs.utah.edu... 192.168.1.56
Connecting to http://apache.cs.utah.edu|192.168.1.56|:80... connected.
@@ -265,7 +265,7 @@ Saving to: "apache-trafodion-installer-1.3.0-incubating-bin.tar.gz"
<<<
```
-$ # Download the Trafodion Server binaries
+$ # Download the {project-name} Server binaries
$ wget http://apache.cs.utah.edu/incubator/trafodion/trafodion-1.3.0.incubating/apache-trafodion-1.3.0-incubating-bin.tar.gz
Resolving http://apache.cs.utah.edu... 192.168.1.56
Connecting to http://apache.cs.utah.edu|192.168.1.56|:80... connected.
@@ -287,12 +287,12 @@ $
[[prepare-preparation-for-recipe-based-provisioning]]
== Preparation for Recipe-Based Provisioning
-NOTE: This step should be skipped if you plan to use the Trafodion Installer
+NOTE: This step should be skipped if you plan to use the {project-name} Installer
[[prepare-modify-os-settings]]
=== Modify OS Settings
-Ensure that the `/etc/security/limits.d/trafodion.conf` on each node contains the limits settings required by Trafodion.
+Ensure that the `/etc/security/limits.d/trafodion.conf` on each node contains the limits settings required by {project-name}.
Refer to <<requirements-operating-system-changes,Operating System Changes>> for the required settings.
[[prepare-modify-zookeeper-configuration]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc
index dd35865..9e6eed8 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/requirements.adoc
@@ -20,15 +20,15 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[requirements]]
= Requirements
-Trafodion requires an x86 version of Linux.
+{project-name} requires an x86 version of Linux.
-The current release of Trafodion has been tested with:
+The current release of {project-name} has been tested with:
* 64-bit Red Hat Enterprise Linux (RHEL) or CentOS 6.5, 6.6, and 6.7
* SUSE SLES 11.3
@@ -36,12 +36,12 @@ The current release of Trafodion has been tested with:
* Cloudera CDH 5.3
* Hortonworks HDP 2.2
-Other OS releases may work, too. The Trafodion project is currently working on better support for non-distribution version of Hadoop.
+Other OS releases may work, too. The {project-name} project is currently working on better support for non-distribution version of Hadoop.
[[requirements-general-cluster-and-os-requirements-and-recommendations]]
== General Cluster and OS Requirements and Recommendations
-64-bit x86 instruction set running a Linux distribution is required. Further, Trafodion assumes an environment
+64-bit x86 instruction set running a Linux distribution is required. Further, {project-name} assumes an environment
based on the requirements of the tested Hadoop distributions/services.
[[requirements-cluster-requirements-and-recommendations]]
@@ -49,15 +49,15 @@ based on the requirements of the tested Hadoop distributions/services.
[[requirements-single-node-cluster]]
==== Single-Node Cluster
-It is possible to run Trafodion on a single-node sandbox environment. Typically, any sandbox running a Hadoop distribution
+It is possible to run {project-name} on a single-node sandbox environment. Typically, any sandbox running a Hadoop distribution
can be used. A typical single-node configuration uses 4-8 cores with 16 GB of memory, and 20 GB free disk space.
[[requirements-multi-node-cluster]]
==== Multi-Node Cluster
-For multi-node end-user clusters, your typical HBase environment should suffice for Trafodion.
+For multi-node end-user clusters, your typical HBase environment should suffice for {project-name}.
Typically, memory configuration range between 64-128 GB per node with minimum requirement of 16 GB.
The cluster size can span from 1 to _n_ nodes; a minimum of two nodes is recommended.
-A minimum of two cores is required regardless of whether you're deploying Trafodion on a bare-metal or virtual environment.
+A minimum of two cores is required regardless of whether you're deploying {project-name} on a bare-metal or virtual environment.
<<<
Recommended configurations:
@@ -82,7 +82,7 @@ Recommended configurations:
[[requirements-os-requirements-and-recommendations]]
=== OS Requirements and Recommendations
-Please verify these requirements on each node you will install Trafodion on:
+Please verify these requirements on each node you will install {project-name} on:
[cols="20%a,40%a,40%a",options="header"]
|===
@@ -99,14 +99,14 @@ Please verify these requirements on each node you will install Trafodion on:
• `/etc/resolv.conf` is configured to use a name server. |
• `host -T <FQDN>` (responds if using a DNS server, times out otherwise) +
• Simply ssh among nodes using `ssh <FQDN>`.
-| Port Availability | The Linux Kernel Firewall (`iptables`) has either been disabled or <<ip-ports,ports required by Trafodion>> have been opened. |
+| Port Availability | The Linux Kernel Firewall (`iptables`) has either been disabled or <<ip-ports,ports required by {project-name}>> have been opened. |
• `lsmod \| grep ip_tables` checks whether `iptables` is loaded. If not, no further checking is needed. +
• `sudo iptables -nL \| grep <port>` checks the configuration of a port. An empty response indicates no rule for the port, which often means
the port is *not* open.
-| passwordless ssh | The user name used to provision Trafodion must have passwordless ssh access to all nodes. | ssh to the nodes, ensure that no password prompt appears.
-| sudo privileges | The user name used to provision Trafodion must sudo access to a number of root functions . | `sudo echo "test"` on each node.
+| passwordless ssh | The user name used to provision {project-name} must have passwordless ssh access to all nodes. | ssh to the nodes, ensure that no password prompt appears.
+| sudo privileges | The user name used to provision {project-name} must sudo access to a number of root functions . | `sudo echo "test"` on each node.
| bash | Available for shell-script execution. | `bash --version`
-| java | Available to run the Trafodion software. Same version as HBase is using. | `java --version`
+| java | Available to run the {project-name} software. Same version as HBase is using. | `java --version`
| perl | Available for script execution. | `perl --version`
| python | Available for script execution. | `python --version`
| yum | Available for installs, updates, and removal of software packages. | `yum --version`
@@ -121,16 +121,16 @@ the port is *not* open.
[[requirements-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.
+The following table lists the default ports used by the different {project-name} components plus the configuration file and configuration attribute associated with each port setting.
[cols="10%h,20%l,20%l,10%,5%,10%,25%",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)
+| 4200 | rest-site.xml | trafodion.rest.port | Yes | 1 | REST | {project-name} REST Server.
+| 4201 | rest-site.xml | trafodion.rest.https.port | Yes | 1 | HTTPS | {project-name} REST Server (HTTPS).
+| 23400 | dcs-site.xml | dcs.master.port | Yes | _n_ | binary | Start of {project-name} DCS port range. (37800 for {project-name} 1.1)
+| 24400 | dcs-site.xml | dcs.master.info.port | Yes | 1 | HTTP | DCS master web GUI. (40010 for {project-name} 1.1)
+| 24410 | dcs-site.xml | dcs.server.info.port | Yes | _n_ | HTTP | Start of range for DCS server web GUIs. (40020 for {project-name} 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.
@@ -139,7 +139,7 @@ The following table lists the default ports used by the different Trafodion comp
| 60030 | hbase-site.xml | hbase.regionserver.info.port | No | 1 | HTTP | HBase Region Server web GUI.
|===
-There are two port ranges used by Trafodion.
+There are two port ranges used by {project-name}.
* 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.
@@ -151,7 +151,7 @@ On top of the ports identified above, you also need the ports required by your H
* 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.
+have {project-name}, HBase, or HDFS servers on them.
[[requirements-prerequisite-software]]
== Prerequisite Software
@@ -159,8 +159,8 @@ have Trafodion, HBase, or HDFS servers on them.
[[requirements-hadoop-software]]
=== Hadoop Software
-Trafodion runs as an add-on service on Hadoop distributions. The following Hadoop services and their dependencies must be installed and running
-on the cluster where you intend to install Trafodion:
+{project-name} runs as an add-on service on Hadoop distributions. The following Hadoop services and their dependencies must be installed and running
+on the cluster where you intend to install {project-name}:
* Hadoop Distributed File System (HDFS)
* YARN with MapReduce version 2
@@ -169,7 +169,7 @@ on the cluster where you intend to install Trafodion:
* Hive
* Apache Ambari (Hortonworks) or Cloudera Manager (Cloudera) with associated embedded databases.
-The following distributions have been tested with Trafodion.^1^
+The following distributions have been tested with {project-name}.^1^
[cols="25%,15%,10%,50%",options="header"]
|===
@@ -179,22 +179,22 @@ http://www.cloudera.com/downloads/manager/5-3-0.html[CDH 5.3 Installation]^2^
| Hortonworks Data Platform (HDP) | 2.2 | 0.98 | http://hortonworks.com/products/releases/hdp-2-2/#install[HDP 2.2 Installation]
|===
-1. Future releases of Trafodion will move away from distribution-specific integration. Instead, Trafodion will be tested with
+1. Future releases of {project-name} will move away from distribution-specific integration. Instead, {project-name} will be tested with
specific version of the Hadoop, HDFS, HBase, and other services/products only.
2. When possible, install using *parcels* to simply the installation process.
-NOTE: Trafodion does not yet support installation on a non-distribution version of Hadoop; that is,
+NOTE: {project-name} does not yet support installation on a non-distribution version of Hadoop; that is,
Hadoop downloaded from the Apache web site. This restriction will be lifted in a later release of
-Trafodion.
+{project-name}.
[[requirements-software-packages]]
=== Software Packages
In addition to the software packages required to run different Hadoop services listed above (for example, `Java`),
-Trafodion requires supplementary software to be installed on the cluster before it is installed. These are Linux
+{project-name} requires supplementary software to be installed on the cluster before it is installed. These are Linux
tools that are not typically packaged as part of the core Linux distribution.
-NOTE: For RedHat/CentOS, the Trafodion Installer automatically attempts get a subset of these packages over the Internet.
+NOTE: For RedHat/CentOS, the {project-name} Installer automatically attempts get a subset of these packages over the Internet.
If the cluster's access to the Internet is disabled, then you need to manually download the packages and make them available
for installation. You need to build and install `log4c++` manually.
@@ -203,9 +203,9 @@ for installation. You need to build and install `log4c++` manually.
| Package | Usage | Installation
| EPEL | Add-on packages to completed the Linux distribution. | Download
http://download.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch[Fedora RPM]
-| pdsh | Parallelize shell commands during install and Trafodion runtime utilities. | yum install pdsh
+| pdsh | Parallelize shell commands during install and {project-name} runtime utilities. | yum install pdsh
| log4cxx | Message logging. | Manual process^1^
-| sqlite | Internal configuration information managed by the Trafodion Foundation component. | yum install sqlite
+| sqlite | Internal configuration information managed by the {project-name} Foundation component. | yum install sqlite
| expect | Not used? | yum install expect
| perl-DBD-SQLite | Allows Perl scripts to connect to SQLite. | yum install perl-DBD-SQLite
| perl-Params-Validate | Validates method/function parameters in Perl scripts. | yum install perl-Params-Validate
@@ -223,37 +223,37 @@ http://download.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch[Fedo
1. `log4c++` was recently withdrawn from public repositories. Therefore, you will need to build the `log4c++` RPM
on your system and then install the RPM using the procedure described in <<log4cplusplus_installation,log4c++ Installation>>.
-2. Software package required to build `log4c++`. Not required otherwise. These packages are *not* installed by the Trafodion Installer in this release.
+2. Software package required to build `log4c++`. Not required otherwise. These packages are *not* installed by the {project-name} Installer in this release.
-The Trafodion Installer requires Internet access to install the required software packages.
+The {project-name} Installer requires Internet access to install the required software packages.
[[requirements-trafodion-user-ids-and-their-privileges]]
-== Trafodion User IDs and Their Privileges
+== {project-name} User IDs and Their Privileges
[[requirements-trafodion-runtime-user]]
-=== Trafodion Runtime User
+=== {project-name} Runtime User
The `trafodion:trafodion` user ID is created as part of the installation process. The default password is: `traf123`.
-Trafodion requires that either HDFS ACL support or Kerberos is enabled. The Trafodion Installer will enable HDFS ACL support.
+{project-name} requires that either HDFS ACL support or Kerberos is enabled. The {project-name} Installer will enable HDFS ACL support.
Kerberos-based security settings are outside the scope of this guide. Please refer to the security information in
https://hbase.apache.org/book.html#security[Apache HBase(TM) Reference Guide] for information about how to set up
HBase security with Kerberos.
-Also, Trafodion requires `sudo` access to `ip` and `arping` so that floating or elastic IP addresses can be moved from one node to
+Also, {project-name} requires `sudo` access to `ip` and `arping` so that floating or elastic IP addresses can be moved from one node to
another in case of node failures.
-NOTE: Do *not* create the `trafodion:trafodion` user ID in advance. The Trafodion Installer uses the presence of this user ID to determine
+NOTE: Do *not* create the `trafodion:trafodion` user ID in advance. The {project-name} Installer uses the presence of this user ID to determine
whether you're doing an installation or upgrade.
[[requirements-trafodion-provisioning-user]]
-=== Trafodion Provisioning User
+=== {project-name} Provisioning User
-Typically, the Trafodion Installer is used for Trafodion installations. It requires access to the user IDs documented below.
+Typically, the {project-name} Installer is used for {project-name} installations. It requires access to the user IDs documented below.
[[requirements-linux-installation-user]]
==== Linux Installation User
-The user ID that performs the Trafodion installation steps. Typically, this User ID runs the Trafodion Installer.
+The user ID that performs the {project-name} installation steps. Typically, this User ID runs the {project-name} Installer.
*Requirements*:
@@ -265,7 +265,7 @@ The user ID that performs the Trafodion installation steps. Typically, this User
** Download and install software packages.
** Modify `/etc/sudoers.d` (allow the `trafodion` user to modify floating IP: `ip` and `arping`).
** Create the `trafodion` user ID and group.
-** Install Trafodion software into the HBase environment.
+** Install {project-name} software into the HBase environment.
** Run Java version command on each node in the cluster.
** Run Hadoop version command on each node in the cluster.
** Run HBase version command on each node in the cluster.
@@ -278,12 +278,12 @@ The user ID that performs the Trafodion installation steps. Typically, this User
*** Modify kernel limits.
*** Reserve IP ports.
-^1^ `sudo` is *required* in the current release of Trafodion. This restriction may be relaxed in later releases.
+^1^ `sudo` is *required* in the current release of {project-name}. This restriction may be relaxed in later releases.
Alternative mechanisms for privileged access (such as running as `root` or `sudo` alternative commands) are not supported.
[[requirements-distribution-manager-user]]
==== Distribution Manager User
-A user ID that can change the configuration using Apache Ambari or Cloudera Manager. The Trafodion Installer makes REST
+A user ID that can change the configuration using Apache Ambari or Cloudera Manager. The {project-name} Installer makes REST
request to perform configuration and control functions to the distribution manager using this user ID.
*Requirements*:
@@ -294,7 +294,7 @@ request to perform configuration and control functions to the distribution manag
[[requirements-hdfs-administrator-user]]
==== HDFS Administrator User
The HDFS super user. Required to create directories and change security settings, as needed.
-The Trafodion Installer uses `su` to run commands under this user ID.
+The {project-name} Installer uses `su` to run commands under this user ID.
*Requirements*:
@@ -313,9 +313,9 @@ The HBase super user. Required to change directory ownership in HDFS.
[[requirements-required-configuration-changes]]
== Required Configuration Changes
-Trafodion requires changes to a number of different areas of your system configuration: operating system, HDFS, and HBase.
+{project-name} requires changes to a number of different areas of your system configuration: operating system, HDFS, and HBase.
-NOTE: These changes are performed by the Trafodion Installer, if used.
+NOTE: These changes are performed by the {project-name} Installer, if used.
[[requirements-operating-system-changes]]
=== Operating System Changes
@@ -323,7 +323,7 @@ NOTE: These changes are performed by the Trafodion Installer, if used.
`/etc/security/limits.d/trafodion.conf` on each node in the cluster must contain the following settings:
```
-# Trafodion settings
+# {project-name} settings
trafodion soft core unlimited
trafodion hard core unlimited
trafodion soft memlock unlimited
@@ -343,12 +343,12 @@ trafodion hard nofile 65535
NOTE: These changes require a restart of ZooKeeper on all nodes in the cluster.
-Trafodion requires the following changes to `zoo.cfg`:
+{project-name} requires the following changes to `zoo.cfg`:
[cols="30%l,40%l,30%a",options="header"]
|===
| Setting | New Value | Purpose
-| maxClientCnxns | 0 | Tell ZooKeeper to impose no limit to the number of connections to enable better Trafodion concurrency.
+| maxClientCnxns | 0 | Tell ZooKeeper to impose no limit to the number of connections to enable better {project-name} concurrency.
|===
[[requirements-hdfs-changes]]
@@ -356,7 +356,7 @@ Trafodion requires the following changes to `zoo.cfg`:
NOTE: These changes require a restart of HDFS on all nodes in the cluster.
-Trafodion requires the following changes to the HDFS environment:
+{project-name} requires the following changes to the HDFS environment:
[cols="60%a,40%a",options="header"]
|===
@@ -364,8 +364,8 @@ Trafodion requires the following changes to the HDFS environment:
| • Create `/hbase-staging` directory. +
• Change owner to HBase Administrator. |
| • Create `/bulkload` directory. +
- • Change owner to `trafodion`. | Used to stage data when processing the Trafodion
-http://trafodion.apache.org/docs/sql_reference/index.html#load_statement[LOAD INTO table]
+ • Change owner to `trafodion`. | Used to stage data when processing the {project-name}
+{docs-url}/sql_reference/index.html#load_statement[LOAD INTO table]
statement and as a temporary directory to create links to actual HFile for snapshot scanning.
| • Create `/lobs` directory. +
• Change owner to `trafodion`. |
@@ -391,16 +391,16 @@ The following changes are required in `hdfs-site.xml`:
NOTE: These changes require a restart of ZooKeeper and HBase on all nodes in the cluster.
-Trafodion requires that the following changes to the HBase environment:
+{project-name} requires that the following changes to the HBase environment:
[cols="25%a,40%a,35%a",options="header"]
|===
| Action | Affected Directories | Purpose
-| Install/replace Trafodion's version of `hbase-trx` | • `/usr/lib/hbase/lib/` +
+| Install/replace {project-name}'s version of `hbase-trx` | • `/usr/lib/hbase/lib/` +
• `/usr/share/cmf/lib/plugins/` (Cloudera) +
• `/usr/hdp/current/hbase-regionserver/lib/` (Hortonworks) |
-Trafodion transaction management relies on an enhanced version of `hbase-trx`.
-| Install/Replace Trafodion utility jar file. | • `/usr/lib/hbase/lib/` +
+{project-name} transaction management relies on an enhanced version of `hbase-trx`.
+| Install/Replace {project-name} utility jar file. | • `/usr/lib/hbase/lib/` +
• `/usr/share/cmf/lib/plugins/` (Cloudera) +
• `/usr/hdp/current/hbase-regionserver/lib` (Hortonworks) |
TODO: Add purpose here.
@@ -424,10 +424,10 @@ hbase.coprocessor.
transactional.TrxRegionEndpoint,
org.apache.hadoop.
hbase.coprocessor.
-AggregateImplementation | Install Trafodion coprocessor classes.
+AggregateImplementation | Install {project-name} coprocessor classes.
| hbase.hregion.impl | org.apache.hadoop.
hbase.regionserver.
-transactional.TransactionalRegion | Trafodion needs to be able to read the Write Ahead Log from a coprocessor using the getScanner method. This method
+transactional.TransactionalRegion | {project-name} needs to be able to read the Write Ahead Log from a coprocessor using the getScanner method. This method
is protected in standard HBase. This change overloads the getScanner method to be public thereby allowing coprocessor code to use it.
| hbase.regionserver.
region.split.policy | org.apache.hadoop.
@@ -435,7 +435,7 @@ hbase.regionserver.
ConstantSizeRegionSplitPolicy | Tell HBase to use the ConstantSizeRegionSplitPolicy for region splitting.
This setting causes region splitting to occur only when the maximum file size is reached.
| hbase.snapshot.
-enabled | true | Enable the HBase Snapshot feature. Used for Trafodion backup and restore.
+enabled | true | Enable the HBase Snapshot feature. Used for {project-name} backup and restore.
| hbase.bulkload.
staging.dir | hbase-staging | Use `/hbase-staging` as the bulk load staging directory.
| hbase.regionserver.region.
@@ -460,7 +460,7 @@ java.heapsize^1^ | 1073741824 (1GB) | Java Heap Size for the HDFS Secondary Name
== Recommended Configuration Changes
The following configuration changes are recommended but not required.
-NOTE: The Trafodion Installer does *not* make these changes.
+NOTE: The {project-name} Installer does *not* make these changes.
[[requirements-recommended-security-changes]]
=== Recommended Security Changes
@@ -499,7 +499,7 @@ from this setting. The underlying issue is the length of the execution of the co
+
NOTE: HBase uses the smaller of `hbase.rpc.timeout` and `hbase.client.scanner.timeout.period` to calculate the scanner timeout.
| hbase.snapshot.master.timeoutMillis and hbase.snapshot.region.timeout | 10 minutes | HBase's default setting is 60000 milliseconds.
-If you experience timeout issues with HBase snapshots when you use the Trafodion Bulk Loader or other statements,
+If you experience timeout issues with HBase snapshots when you use the {project-name} Bulk Loader or other statements,
you can set the value for these two HBase properties to 10 minutes (600,000 milliseconds).
| hbase.hregion.max.filesize | 107374182400 bytes | HBase's default setting is 10737418240 (10 GB). We have increased the setting to
107374182400 (100 GB), which reduces the number of HStoreFiles per table and appears to reduce disruptions to active transactions from
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/script_install.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/script_install.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/script_install.adoc
index cde5718..44afd49 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/script_install.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/script_install.adoc
@@ -20,26 +20,26 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[install]]
= Install
-This chapter describes how to use the Trafodion Installer to install Trafodion. You use the Trafodion Provisioning ID
-to run the Trafodion Installer.
+This chapter describes how to use the {project-name} Installer to install {project-name}. You use the {project-name} Provisioning ID
+to run the {project-name} Installer.
-NOTE: You *must* install log4c++ on all nodes in the cluster prior to running the Trafodion Installer. Refer
+NOTE: Prior to version 2.0.0, you *must* install log4c++ on all nodes in the cluster prior to running the {project-name} Installer. Refer
to <<prepare-build-and-install-log4cplusplus,Build and Install log4c++>> for instructions.
[[install-unpack-installer]]
== Unpack Installer
-You should already have downloaded the Trafodion Binaries per the instructions in the
-<<prepare-download-trafodion-binaries,Download Trafodion Binaries>> in the <<prepare,Prepare>>
+You should already have downloaded the {project-name} Binaries per the instructions in the
+<<prepare-download-trafodion-binaries,Download {project-name} Binaries>> in the <<prepare,Prepare>>
chapter. If not, please do so now.
-The first step in the installation process is to unpack the Trafodion Installer tar file.
+The first step in the installation process is to unpack the {project-name} Installer tar file.
*Example*
@@ -59,20 +59,20 @@ $
[[install-automated-install]]
== Automated Install
-The `--config_file` option runs the Trafodion in Automated Setup mode. Refer to <<introduction-trafodion-installer,Trafodion Installer>>
+The `--config_file` option runs the {project-name} in Automated Setup mode. Refer to <<introduction-trafodion-installer,{project-name} Installer>>
in the <<introduction,Introduction>> chapter for instructions of how you edit your configuration file.
Edit your config file using the information you collected in the <<prepare-gather-configuration-information,Gather Configuration Information>>
step in the <<prepare,Prepare>> chapter.
-The following example shows an automated install of Trafodion on a two-node Hortonworks Hadoop cluster.
+The following example shows an automated install of {project-name} on a two-node Hortonworks Hadoop cluster.
-NOTE: By default, the Trafodion Installer invokes `sqlci` so that you can enter the `initialize trafodion;` command.
+NOTE: By default, the {project-name} Installer invokes `sqlci` so that you can enter the `initialize trafodion;` command.
This is shown in the example below.
*Example*
-1. Run the Trafodion Installer in Automated Setup mode.
+1. Run the {project-name} Installer in Automated Setup mode.
+
```
$ cd $HOME/trafodion-installer/installer
@@ -87,7 +87,7 @@ $ ./trafodion_install --config_file my
***INFO: Working directory: /usr/lib/trafodion
************************************
- Trafodion Configuration File Check
+ {project-name} Configuration File Check
************************************
@@ -103,14 +103,14 @@ $ ./trafodion_install --config_file my
***INFO: Testing sudo access on trafodion-1
***INFO: Testing sudo access on trafodion-2
***DEBUG: trafodionFullName=trafodion_server-1.3.0.tgz
-***INFO: Trafodion version = 1.3.0
+***INFO: {project-name} version = 1.3.0
***DEBUG: HBase's java_exec=/usr/jdk64/jdk1.7.0_67/bin/java
******************************
TRAFODION SETUP
******************************
-***INFO: Starting Trafodion environment setup (2016-02-16-21-12-31)
+***INFO: Starting {project-name} environment setup (2016-02-16-21-12-31)
=== 2016-02-16-21-12-31 ===
# @@@ START COPYRIGHT @@@
#
@@ -142,7 +142,7 @@ BY TYPING "ACCEPT" YOU AGREE TO THE TERMS OF THIS AGREEMENT: ***INFO: testing su
trafodion-1
trafodion-2
***INFO: Total number of nodes = 2
-***INFO: Starting Trafodion Package Setup (2016-02-16-21-12-35)
+***INFO: Starting {project-name} Package Setup (2016-02-16-21-12-35)
***INFO: Installing required packages
***INFO: Log file located in /var/log/trafodion
***INFO: ... EPEL rpm
@@ -155,7 +155,7 @@ trafodion-2
.
.
***INFO: trafodion user added successfully
-***INFO: Trafodion environment setup completed
+***INFO: {project-name} environment setup completed
***INFO: creating sqconfig file
***INFO: Reserving DCS ports
@@ -194,7 +194,7 @@ You can monitor the SQ shell log file : /home/trafodion/apache-trafodion-1.3.0-i
Startup time 0 hour(s) 1 minute(s) 9 second(s)
-Apache Trafodion Conversational Interface 1.3.0
+Apache {project-name} Conversational Interface 1.3.0
Copyright (c) 2015 Apache Software Foundation
>> initialize trafodion;
--- SQL operation complete.
@@ -211,7 +211,7 @@ End of MXCI Session
$
```
-2. Switch to the Trafodion Runtime User and check the status of Trafodion.
+2. Switch to the {project-name} Runtime User and check the status of {project-name}.
+
*Example*
+
@@ -233,24 +233,24 @@ MXOSRVR 8 8
$
```
-Trafodion is now running on your Hadoop cluster. Please refer to the <<activate,Activate>> chapter for
-basic instructions on how to verify the Trafodion management and how to perform basic management
+{project-name} is now running on your Hadoop cluster. Please refer to the <<activate,Activate>> chapter for
+basic instructions on how to verify the {project-name} management and how to perform basic management
operations.
[[install-guided-install]]
== Guided Install
-The Trafodion Installer prompts you for the information you collected in the
+The {project-name} Installer prompts you for the information you collected in the
<<prepare-gather-configuration-information, Gather Configuration Information>> step in the <<prepare,Prepare>> chapter.
-The following example shows a guided install of Trafodion on a two-node Cloudera Hadoop cluster.
+The following example shows a guided install of {project-name} on a two-node Cloudera Hadoop cluster.
-NOTE: By default, the Trafodion Installer invokes `sqlci` so that you can enter the `initialize trafodion;` command.
+NOTE: By default, the {project-name} Installer invokes `sqlci` so that you can enter the `initialize trafodion;` command.
This is shown in the example below.
*Example*
-1. Run the Trafodion Installer in guided mode.
+1. Run the {project-name} Installer in guided mode.
+
```
$ cd $HOME/trafodion-installer/installer
@@ -266,14 +266,14 @@ $ ./trafodion_install
***INFO: Working directory: /usr/lib/trafodion
*******************************
- Trafodion Configuration Setup
+ {project-name} Configuration Setup
*******************************
***INFO: Please press [Enter] to select defaults.
Enter trafodion password, default is [traf123]: traf123
Enter list of nodes (blank separated), default []: trafodion-1 trafodion-2
-Enter Trafodion userid's home directory prefix, default is [/home]: /home
+Enter {project-name} userid's home directory prefix, default is [/home]: /home
Specify full path to EPEL RPM (including .rpm), default is None:
***INFO: Will attempt to download RPM if EPEL is not installed on all nodes.
Specify location of Java 1.7.0_65 or higher (JDK), default is []: /usr/java/jdk1.7.0_67-cloudera
@@ -288,10 +288,10 @@ Enter directory to install trafodion to, default is [/home/trafodion/apache-traf
Total number of client connections per node, default [16]: 8
Enable simple LDAP security (Y/N), default is N: N
***INFO: Configuration file: /etc/trafodion/trafodion_config
-***INFO: Trafodion configuration setup complete
+***INFO: {project-name} configuration setup complete
************************************
- Trafodion Configuration File Check
+ {project-name} Configuration File Check
************************************
@@ -310,14 +310,14 @@ Are you sure you want to continue connecting (yes/no)? yes
***INFO: Testing sudo access on trafodion-1
***INFO: Testing sudo access on trafodion-2
***DEBUG: trafodionFullName=trafodion_server-1.3.0.tgz
-***INFO: Trafodion version = 1.3.0
+***INFO: {project-name} version = 1.3.0
***DEBUG: HBase's java_exec=/usr/java/jdk1.7.0_67-cloudera/bin/java
******************************
TRAFODION SETUP
******************************
-***INFO: Starting Trafodion environment setup (2016-02-15-07-09-58)
+***INFO: Starting {project-name} environment setup (2016-02-15-07-09-58)
=== 2016-02-15-07-09-58 ===
# @@@ START COPYRIGHT @@@
#
@@ -344,7 +344,7 @@ BY TYPING "ACCEPT" YOU AGREE TO THE TERMS OF THIS AGREEMENT:ACCEPT
trafodion-1
trafodion-2
***INFO: Total number of nodes = 2
-***INFO: Starting Trafodion Package Setup (2016-02-15-07-11-09)
+***INFO: Starting {project-name} Package Setup (2016-02-15-07-11-09)
***INFO: Installing required packages
***INFO: Log file located in /var/log/trafodion
***INFO: ... pdsh on node trafodion-1
@@ -357,8 +357,8 @@ trafodion-2
.
.
***INFO: modifying limits in /usr/lib/trafodion/trafodion.conf on all nodes
-***INFO: create Trafodion userid "trafodion"
-***INFO: Trafodion userid's (trafodion) home directory: /home/trafodion
+***INFO: create {project-name} userid "trafodion"
+***INFO: {project-name} userid's (trafodion) home directory: /home/trafodion
***INFO: testing sudo access
Generating public/private rsa key pair.
Created directory '/home/trafodion/.ssh'.
@@ -384,7 +384,7 @@ The key's randomart image is:
trafodion-1
trafodion-2
***INFO: trafodion user added successfully
-***INFO: Trafodion environment setup completed
+***INFO: {project-name} environment setup completed
***INFO: creating sqconfig file
***INFO: Reserving DCS ports
@@ -407,7 +407,7 @@ trafodion-2
***INFO: waiting for HDFS to exit safemode
Safe mode is OFF
***INFO: Setting HDFS ACLs for snapshot scan support
-***INFO: Trafodion Mods ran successfully.
+***INFO: {project-name} Mods ran successfully.
******************************
TRAFODION START
@@ -442,7 +442,7 @@ Creating folders for storing certificates
***INFO: copying /home/trafodion/sqcert directory to all nodes
***INFO: copying install to all nodes
-***INFO: starting Trafodion instance
+***INFO: starting {project-name} instance
Checking orphan processes.
Removing old mpijob* files from /home/trafodion/apache-trafodion-1.3.0-incubating-bin/tmp
@@ -468,7 +468,7 @@ You can monitor the SQ shell log file : /home/trafodion/apache-trafodion-1.3.0-i
Startup time 0 hour(s) 1 minute(s) 9 second(s)
-Apache Trafodion Conversational Interface 1.3.0
+Apache {project-name} Conversational Interface 1.3.0
Copyright (c) 2015 Apache Software Foundation
>> initialize trafodion;
--- SQL operation complete.
@@ -485,7 +485,7 @@ End of MXCI Session
$
```
-2. Switch to the Trafodion Runtime User and check the status of Trafodion.
+2. Switch to the {project-name} Runtime User and check the status of {project-name}.
+
```
$ sudo su - trafodion
@@ -505,7 +505,7 @@ MXOSRVR 8 8
$
```
-Trafodion is now running on your Hadoop cluster. Please refer to the <<activate,Activate>> chapter for
-basic instructions on how to verify the Trafodion management and how to perform basic management
+{project-name} is now running on your Hadoop cluster. Please refer to the <<activate,Activate>> chapter for
+basic instructions on how to verify the {project-name} management and how to perform basic management
operations.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/script_remove.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/script_remove.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/script_remove.adoc
index 275592d..0491f3a 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/script_remove.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/script_remove.adoc
@@ -20,19 +20,19 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[remove]]
= Remove
-You use the Trafodion Provisioning User for these instructions.
+You use the {project-name} Provisioning User for these instructions.
-NOTE: You do not need to use the `trafodion_uninstaller` script if upgrading Trafodion. Instead, use the `trafodion_install` script,
-which automatically upgrades the version of Trafodion. Please refer to the <<install,Install>> chapter for further instructions.
+NOTE: You do not need to use the `trafodion_uninstaller` script if upgrading {project-name}. Instead, use the `trafodion_install` script,
+which automatically upgrades the version of {project-name}. Please refer to the <<install,Install>> chapter for further instructions.
-Run the commands from the first node of the cluster. Do not run them from a machine that is not part of the Trafodion cluster.
+Run the commands from the first node of the cluster. Do not run them from a machine that is not part of the {project-name} cluster.
-== Stop Trafodion
+== Stop {project-name}
Do the following:
@@ -86,17 +86,17 @@ Mon Feb 15 07:49:26 UTC 2016
== Run `trafodion_uninstaller`
-The `trafodion_uninstaller` completely removes Trafodion.
+The `trafodion_uninstaller` completely removes {project-name}.
*Example*
```
[admin@trafodion-1 ~]$ cd $HOME/trafodion-installer/installer
[admin@trafodion-1 installer]$ ./trafodion_uninstaller
-Do you want to uninstall Trafodion (Everything will be removed)? (Y/N) y
+Do you want to uninstall {project-name} (Everything will be removed)? (Y/N) y
***INFO: testing sudo access
***INFO: NOTE, rpms that were installed will not be removed.
-***INFO: stopping Trafodion instance
+***INFO: stopping {project-name} instance
SQ environment is not up.
Going to execute ckillall
@@ -109,10 +109,10 @@ pdsh@trafodion-1: trafodion-1: ssh exited with exit code 1
pdsh@trafodion-1: trafodion-2: ssh exited with exit code 1
pdsh@trafodion-1: trafodion-1: ssh exited with exit code 1
pdsh@trafodion-1: trafodion-2: ssh exited with exit code 1
-***INFO remove the Trafodion userid and group
+***INFO remove the {project-name} userid and group
***INFO: removing all files from /home/trafodion/apache-trafodion-1.3.0-incubating-bin
***INFO: removing all files from /usr/lib/trafodion and /var/log/trafodion
***INFO: removing all files from /etc/trafodion
-***INFO: Trafodion uninstall complete.
+***INFO: {project-name} uninstall complete.
[admin@trafodion-1 installer]$
```
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/script_upgrade.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/script_upgrade.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/script_upgrade.adoc
index 0d27a08..a79fa51 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/script_upgrade.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/script_upgrade.adoc
@@ -20,35 +20,35 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[upgrade]]
= Upgrade
-This chapter describes how to use the Trafodion Installer to upgrade Trafodion. You use the Trafodion Provisioning ID
-to run the Trafodion Installer.
+This chapter describes how to use the {project-name} Installer to upgrade {project-name}. You use the {project-name} Provisioning ID
+to run the {project-name} Installer.
[[upgraded-download-updated-trafodion-binaries]]
-== Download Updated Trafodion Binaries
+== Download Updated {project-name} Binaries
-You perform this step as the Trafodion Provisioning User.
+You perform this step as the {project-name} Provisioning User.
-You download the updated Trafodion binaries from the Trafodion http://trafodion.apache.org/download.html[Download] page.
+You download the updated {project-name} binaries from the {project-name} {download-url}[Download] page.
Download the following packages:
-* Trafodion Installer (if planning to use the Trafodion Installer)
-* Trafodion Server
+* {project-name} Installer (if planning to use the {project-name} Installer)
+* {project-name} Server
-Refer to <<prepare-download-trafodion-binaries, Download Trafodion Binaries>> in the <<prepare,Prepare>> chapter for examples.
+Refer to <<prepare-download-trafodion-binaries, Download {project-name} Binaries>> in the <<prepare,Prepare>> chapter for examples.
[[upgrade-unpack-installer]]
== Unpack Installer
-You perform this step as the Trafodion Provisioning User.
+You perform this step as the {project-name} Provisioning User.
-You unpack the updated Trafodion Installer into a new directory.
+You unpack the updated {project-name} Installer into a new directory.
*Example*
@@ -66,8 +66,8 @@ $
```
[[upgrade-stop-tradodion]]
-== Stop Trafodion
-You perform this step as the Trafodion Runtime User.
+== Stop {project-name}
+You perform this step as the {project-name} Runtime User.
*Example*
@@ -85,7 +85,7 @@ stopped $zlobsrv1
Shutting down (normal) the SQ environment!
Wed Feb 17 05:12:40 UTC 2016
Processing cluster.conf on local host trafodion-1
-[$Z000KAE] Shell/shell Version 1.0.1 Apache_Trafodion Release 1.3.0 (Build release [1.3.0-0-g5af956f_Bld2], date 20160112_1927)
+[$Z000KAE] Shell/shell Version 1.0.1 Apache_{project-name} Release 1.3.0 (Build release [1.3.0-0-g5af956f_Bld2], date 20160112_1927)
ps
```
@@ -132,9 +132,9 @@ $
[[upgrade-automated-upgrade]]
== Automated Upgrade
-You perform this step as the Trafodion Provisioning User.
+You perform this step as the {project-name} Provisioning User.
-The `--config_file` option runs the Trafodion in Automated Setup mode. Refer to <<introduction-trafodion-installer,Trafodion Installer>>
+The `--config_file` option runs the {project-name} in Automated Setup mode. Refer to <<introduction-trafodion-installer,{project-name} Installer>>
in the <<introduction,Introduction>> chapter for instructions of how you edit your configuration file.
At a minimum, you need to change the following settings:
@@ -163,15 +163,15 @@ export TRAF_PACKAGE="/home/centos/trafodion-download/apache-trafodion-2.0.0-incu
export SQ_ROOT="/home/trafodion/apache-trafodion-2.0.0-incubating-bin"
```
-The following example shows an upgrade of Trafodion on a two-node Hortonworks Hadoop cluster using
+The following example shows an upgrade of {project-name} on a two-node Hortonworks Hadoop cluster using
Automated Setup mode.
-NOTE: The Trafodion Installer performs the same configuration changes as it does for an installation,
+NOTE: The {project-name} Installer performs the same configuration changes as it does for an installation,
including restarting Hadoop services.
*Example*
-1. Run the updated Trafodion Installer using the modified my_config_2.0 file.
+1. Run the updated {project-name} Installer using the modified my_config_2.0 file.
+
```
$ cd $HOME/trafodion-installer-2.0/installer
@@ -191,9 +191,9 @@ $ ./trafodion_install --config_file $HOME/trafodion-configuration/my_config_2.0
***INFO: Testing ssh on trafodion-2
***INFO: Testing sudo access on trafodion-1
***INFO: Testing sudo access on trafodion-2
-***INFO: Trafodion scanner will not be run.
+***INFO: {project-name} scanner will not be run.
***DEBUG: trafodionFullName=trafodion_server-2.0.0.tgz
-***INFO: Trafodion version = 2.0.0
+***INFO: {project-name} version = 2.0.0
***DEBUG: HBase's java_exec=/usr/jdk64/jdk1.7.0_67/bin/java
******************************
@@ -201,7 +201,7 @@ $ ./trafodion_install --config_file $HOME/trafodion-configuration/my_config_2.0
******************************
***INFO: Installing required RPM packages
-***INFO: Starting Trafodion Package Setup (2016-02-17-05-33-29)
+***INFO: Starting {project-name} Package Setup (2016-02-17-05-33-29)
***INFO: Installing required packages
***INFO: Log file located in /var/log/trafodion
***INFO: ... pdsh on node trafodion-1
@@ -223,7 +223,7 @@ You can monitor the SQ shell log file : /home/trafodion/apache-trafodion-2.0.0-i
Startup time 0 hour(s) 1 minute(s) 9 second(s)
-Apache Trafodion Conversational Interface 1.3.0
+Apache {project-name} Conversational Interface 1.3.0
Copyright (c) 2015 Apache Software Foundation
>>Metadata Upgrade: started
@@ -248,7 +248,7 @@ End of MXCI Session
$
```
-2. Switch to the Trafodion Runtime User and check the status of Trafodion.
+2. Switch to the {project-name} Runtime User and check the status of {project-name}.
+
```
$ sudo su - trafodion
@@ -268,17 +268,17 @@ MXOSRVR 8 8
$
```
-Trafodion is now running on your Hadoop cluster. Please refer to the <<activate,Activate>> chapter for
-basic instructions on how to verify the Trafodion management and how to perform basic management
+{project-name} is now running on your Hadoop cluster. Please refer to the <<activate,Activate>> chapter for
+basic instructions on how to verify the {project-name} management and how to perform basic management
operations.
<<<
[[upgrade-guided-upgrade]]
== Guided Upgrade
-You perform this step as the Trafodion Provisioning User.
+You perform this step as the {project-name} Provisioning User.
-As in the case with an installation, the Trafodion Installer prompts you for the information you collected in the
+As in the case with an installation, the {project-name} Installer prompts you for the information you collected in the
<<prepare-gather-configuration-information, Gather Configuration Information>> step in the <<prepare,Prepare>> chapter.
Some of the prompts are populated with the current values.
@@ -287,11 +287,11 @@ export TRAF_PACKAGE="/home/centos/trafodion-download/apache-trafodion-1.3.0-incu
export SQ_ROOT="/home/trafodion/apache-trafodion-1.3.0-incubating-bin"
-The following example shows a guided upgrade of Trafodion on a two-node Cloudera Hadoop cluster.
+The following example shows a guided upgrade of {project-name} on a two-node Cloudera Hadoop cluster.
*Example*
-1. Run the updated Trafodion Installer in Guided Setup mode to perform the upgrade. Change information
+1. Run the updated {project-name} Installer in Guided Setup mode to perform the upgrade. Change information
at prompts as applicable.
+
```
@@ -307,7 +307,7 @@ $ ./trafodion_install
***INFO: Working directory: /usr/lib/trafodion
*******************************
- Trafodion Configuration Setup
+ {project-name} Configuration Setup
*******************************
***INFO: Please press [Enter] to select defaults.
@@ -323,14 +323,14 @@ Enter HDFS username, default is [hdfs]:
Enter HBase username, default is [hbase]:
Enter HBase group, default is [hbase]:
Enter directory to install trafodion to, default is [/home/trafodion/apache-trafodion-1.3.0-incubating-bin]: /home/centos/apache-trafodion-2.0.0-incubating-bin
-Start Trafodion after install (Y/N), default is Y:
+Start {project-name} after install (Y/N), default is Y:
Total number of client connections per node, default [16]: 8
Enable simple LDAP security (Y/N), default is N:
***INFO: Configuration file: /etc/trafodion/trafodion_config
-***INFO: Trafodion configuration setup complete
+***INFO: {project-name} configuration setup complete
************************************
- Trafodion Configuration File Check
+ {project-name} Configuration File Check
************************************
@@ -348,9 +348,9 @@ Enable simple LDAP security (Y/N), default is N:
***INFO: Checking cloudera Version
***INFO: nameOfVersion=cdh5.3.0
***INFO: HADOOP_PATH=/usr/lib/hbase/lib
-***INFO: Trafodion scanner will not be run.
+***INFO: {project-name} scanner will not be run.
***DEBUG: trafodionFullName=trafodion_server-1.3.0.tgz
-***INFO: Trafodion version = 1.3.0
+***INFO: {project-name} version = 1.3.0
***DEBUG: HBase's java_exec=/usr/java/jdk1.7.0_67-cloudera/bin/java
******************************
@@ -358,7 +358,7 @@ Enable simple LDAP security (Y/N), default is N:
******************************
***INFO: Installing required RPM packages
-***INFO: Starting Trafodion Package Setup (2016-02-17-08-16-11)
+***INFO: Starting {project-name} Package Setup (2016-02-17-08-16-11)
***INFO: Installing required packages
***INFO: Log file located in /var/log/trafodion
***INFO: ... pdsh on node trafodion-1
@@ -400,7 +400,7 @@ You can monitor the SQ shell log file : /home/trafodion/apache-trafodion-2.0.0-i
Startup time 0 hour(s) 1 minute(s) 9 second(s)
-Apache Trafodion Conversational Interface 1.3.0
+Apache {project-name} Conversational Interface 1.3.0
Copyright (c) 2015 Apache Software Foundation
>>
@@ -415,7 +415,7 @@ End of MXCI Session
$
```
-2. Switch to the Trafodion Runtime User and check the status of Trafodion.
+2. Switch to the {project-name} Runtime User and check the status of {project-name}.
+
```
$ sudo su - trafodion
@@ -435,8 +435,8 @@ MXOSRVR 8 8
$
```
-Trafodion is now running on your Hadoop cluster. Please refer to the <<activate,Activate>> chapter for
-basic instructions on how to verify the Trafodion management and how to perform basic management
+{project-name} is now running on your Hadoop cluster. Please refer to the <<activate,Activate>> chapter for
+basic instructions on how to verify the {project-name} management and how to perform basic management
operations.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/index.adoc b/docs/provisioning_guide/src/asciidoc/index.adoc
index 0cf21ce..0e87035 100644
--- a/docs/provisioning_guide/src/asciidoc/index.adoc
+++ b/docs/provisioning_guide/src/asciidoc/index.adoc
@@ -32,7 +32,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
:images: ../images
:leveloffset: 1
@@ -41,22 +42,9 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-**License Statement**
-
-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.
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 1.3.0 | January, 2016
-|===
+include::../../shared/license.txt[]
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/shared/acknowledgements.txt
----------------------------------------------------------------------
diff --git a/docs/shared/acknowledgements.txt b/docs/shared/acknowledgements.txt
new file mode 100644
index 0000000..c395596
--- /dev/null
+++ b/docs/shared/acknowledgements.txt
@@ -0,0 +1,38 @@
+*Acknowledgements*
+
+Microsoft�, Windows�, Windows NT�, Windows� XP, and Windows Vista� are
+U.S. registered trademarks of Microsoft Corporation. Intel� and Intel�
+Itanium� are trademarks of Intel Corporation in the U.S. and other
+countries. Java� is a registered trademark of Oracle and/or its
+affiliates. Motif, OSF/1, UNIX�, X/Open�, and the X device is a
+trademark of X/Open Company Ltd. in the UK and other countries.
+
+OSF, OSF/1, OSF/Motif, Motif, and Open Software Foundation are trademarks of
+the Open Software Foundation in the U.S. and other countries.
+� 1990, 1991, 1992, 1993 Open Software Foundation, Inc.
+
+The OSF documentation and the OSF software to which it relates are derived in
+part from materials supplied by the following: � 1987, 1988, 1989
+Carnegie-Mellon University. � 1989, 1990, 1991 Digital Equipment
+Corporation. � 1985, 1988, 1989, 1990 Encore Computer Corporation. � 1988 Free
+Software Foundation, Inc. � 1987, 1988, 1989, 1990, 1991 Hewlett-Packard
+Company. � 1985, 1987, 1988, 1989, 1990, 1991, 1992 International
+Business Machines Corporation. � 1988, 1989 Massachusetts Institute of
+Technology. � 1988, 1989, 1990 Mentat Inc. � 1988 Microsoft Corporation.
+� 1987, 1988, 1989, 1990, 1991,
+1992 SecureWare, Inc. � 1990, 1991 Siemens Nixdorf Informations systeme
+AG. � 1986, 1989, 1996, 1997 Sun Microsystems, Inc. � 1989, 1990, 1991
+Transarc Corporation.
+
+OSF software and documentation are based in part
+on the Fourth Berkeley Software Distribution under license from The
+Regents of the University of California. OSF acknowledges the following
+individuals and institutions for their role in its development: Kenneth
+C.R.C. Arnold, Gregory S. Couch, Conrad C. Huang, Ed James, Symmetric
+Computer Systems, Robert Elz. � 1980, 1981, 1982, 1983, 1985, 1986,
+1987, 1988, 1989 Regents of the University of California. OSF MAKES NO
+WARRANTY OF ANY KIND WITH REGARD TO THE OSF MATERIAL PROVIDED HEREIN,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE. OSF shall not be liable for errors
+contained herein or for incidental consequential damages in connection
+with the furnishing, performance, or use of this material.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/shared/revisions.txt
----------------------------------------------------------------------
diff --git a/docs/shared/revisions.txt b/docs/shared/revisions.txt
new file mode 100644
index 0000000..2408fd1
--- /dev/null
+++ b/docs/shared/revisions.txt
@@ -0,0 +1,32 @@
+////
+* @@@ 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 @@@
+////
+
+*Revision History*
+
+[cols="2",options="header"]
+|===
+| Version | Date
+| 2.0.0 | To be announced.
+| 1.3.0 | January, 2016
+|===
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/about.adoc b/docs/spj_guide/src/asciidoc/_chapters/about.adoc
index fa484cd..de8bb56 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/about.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/about.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/create_spjs.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/create_spjs.adoc b/docs/spj_guide/src/asciidoc/_chapters/create_spjs.adoc
index 7eb409c..370877b 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/create_spjs.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/create_spjs.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[create-spjs]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/deploy_spjs.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/deploy_spjs.adoc b/docs/spj_guide/src/asciidoc/_chapters/deploy_spjs.adoc
index 1f7ad25..7f55713 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/deploy_spjs.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/deploy_spjs.adoc
@@ -1,23 +1,23 @@
////
/**
*@@@ 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 @@@
- */
+* 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 @@@
+*/
////
[[deploy-spj-jar-files]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/develop_spjs.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/develop_spjs.adoc b/docs/spj_guide/src/asciidoc/_chapters/develop_spjs.adoc
index acd0248..1cf0da8 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/develop_spjs.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/develop_spjs.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[develop-spj-methods]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/execute_spjs.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/execute_spjs.adoc b/docs/spj_guide/src/asciidoc/_chapters/execute_spjs.adoc
index 5100227..81c341d 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/execute_spjs.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/execute_spjs.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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,
+*@@@ 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 @@@
- */
+* See the License for the specific language governing permissions and
+* limitations under the License.
+* @@@ END COPYRIGHT @@@
+*/
////
[[execute-spjs]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/spj_guide/src/asciidoc/_chapters/get_started.adoc
----------------------------------------------------------------------
diff --git a/docs/spj_guide/src/asciidoc/_chapters/get_started.adoc b/docs/spj_guide/src/asciidoc/_chapters/get_started.adoc
index eeb4756..18c9af2 100644
--- a/docs/spj_guide/src/asciidoc/_chapters/get_started.adoc
+++ b/docs/spj_guide/src/asciidoc/_chapters/get_started.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
[[get-started]]
[09/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/sql_statements.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/sql_statements.adoc b/docs/sql_reference/src/asciidoc/_chapters/sql_statements.adoc
index 4ead225..c498c82 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/sql_statements.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/sql_statements.adoc
@@ -20,18 +20,18 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[sql_statements]]
= SQL Statements
-This section describes the syntax and semantics of Trafodion SQL statements.
+This section describes the syntax and semantics of {project-name} SQL statements.
-Trafodion SQL statements are entered interactively or from script files using a client-based tool, such as the
-Trafodion Command Interface (TrafCI). To install and configure a client application that enables you to connect
-to and use a Trafodion database, see the
-http://trafodion.incubator.apache.org/docs/client_install/index.html[_Trafodion Client Installation_ _Guide_].
+{project-name} SQL statements are entered interactively or from script files using a client-based tool, such as the
+{project-name} Command Interface (TrafCI). To install and configure a client application that enables you to connect
+to and use a {project-name} database, see the
+{docs-url}/client_install/index.html[_{project-name} Client Installation_ _Guide_].
[[sql_statements_categories]]
== Categories
@@ -52,31 +52,31 @@ The statements are categorized according to their functionality:
[[data_definition_language_statements]]
=== Data Definition Language (DDL) Statements
-Use these DDL statements to create, drop, or alter the definition of a Trafodion SQL schema or object.
+Use these DDL statements to create, drop, or alter the definition of a {project-name} SQL schema or object.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run DDL statements inside a user-defined
transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run these statements, AUTOCOMMIT must be turned ON
(the default) for the session.
-[cols="2*", options="headhttp://trafodion.apache.org/docs/sql_reference/index.html#limitser"]
+[cols="2*", options="head{docs-url}/sql_reference/index.html#limitser"]
|===
| Statement | What It Does
-// | <<alter_library_statement,ALTER LIBRARY Statement>> | Updates the physical filename for a library object in a Trafodion database.
+// | <<alter_library_statement,ALTER LIBRARY Statement>> | Updates the physical filename for a library object in a {project-name} database.
| <<alter_table_statement,ALTER TABLE Statement>> | Changes attributes for a table.
| <<alter_user_statement,ALTER USER Statement>> | Changes attributes for a user.
-| <<create_function_statement,CREATE FUNCTION Statement>> | Registers a user-defined function (UDF) written in C as a function within a Trafodion database.
+| <<create_function_statement,CREATE FUNCTION Statement>> | Registers a user-defined function (UDF) written in C as a function within a {project-name} database.
| <<create_index_statement,CREATE INDEX Statement>> | Creates an index on a table.
-| <<create_library_statement,CREATE LIBRARY Statement>> | Registers a library object in a Trafodion database.
-| <<create_procedure_statement,CREATE PROCEDURE Statement>> | Registers a Java method as a stored procedure in Java (SPJ) within a Trafodion database.
+| <<create_library_statement,CREATE LIBRARY Statement>> | Registers a library object in a {project-name} database.
+| <<create_procedure_statement,CREATE PROCEDURE Statement>> | Registers a Java method as a stored procedure in Java (SPJ) within a {project-name} database.
| <<create_role_statement,CREATE ROLE Statement>> | Creates a role.
| <<create_schema_statement,CREATE SCHEMA Statement>> | Creates a schema in the database.
| <<create_table_statement,CREATE TABLE Statement>> | Creates a table.
| <<create_view_statement,CREATE VIEW Statement>> | Creates a view.
-| <<drop_function_statement,DROP FUNCTION Statement>> | Removes a user-defined function (UDF) from the Trafodion database.
+| <<drop_function_statement,DROP FUNCTION Statement>> | Removes a user-defined function (UDF) from the {project-name} database.
| <<drop_index_statement,DROP INDEX Statement>> | Drops an index.
-| <<drop_library_statement,DROP LIBRARY Statement>> | Removes a library object from the Trafodion database and also removes the library file
+| <<drop_library_statement,DROP LIBRARY Statement>> | Removes a library object from the {project-name} database and also removes the library file
referenced by the library object.
-| <<drop_procedure_statement,DROP PROCEDURE Statement>> | Removes a stored procedure in Java (SPJ) from the Trafodion database.
+| <<drop_procedure_statement,DROP PROCEDURE Statement>> | Removes a stored procedure in Java (SPJ) from the {project-name} database.
| <<drop_role_statement,DROP ROLE Statement>> | Drops a role.
| <<drop_schema_statement,DROP SCHEMA Statement>> | Drops a schema from the database.
| <<drop_table_statement,DROP TABLE Statement>> | Drops a table.
@@ -155,15 +155,15 @@ authorization to access libraries or to execute SPJs or UDFs:
[cols="2*",options="header"]
|===
| Statement | What It Does
-// | <<alter_library_statement,ALTER LIBRARY Statement>> | Updates the physical filename for a library object in a Trafodion database.
-| <<call_statement,CALL Statement>> | Initiates the execution of a stored procedure in Java (SPJ) in a Trafodion database.
-| <<create_function_statement,CREATE FUNCTION Statement>> | Registers a user-defined function (UDF) written in C as a function within a Trafodion database.
-| <<create_library_statement,CREATE LIBRARY Statement>> | Registers a library object in a Trafodion database.
-| <<create_procedure_statement,CREATE PROCEDURE Statement>> | Registers a Java method as a stored procedure in Java (SPJ) within a Trafodion database.
-| <<drop_function_statement,DROP FUNCTION Statement>> | Removes a user-defined function (UDF) from the Trafodion database.
-| <<drop_library_statement,DROP LIBRARY Statement>> | Removes a library object from the Trafodion database and also removes the library file
+// | <<alter_library_statement,ALTER LIBRARY Statement>> | Updates the physical filename for a library object in a {project-name} database.
+| <<call_statement,CALL Statement>> | Initiates the execution of a stored procedure in Java (SPJ) in a {project-name} database.
+| <<create_function_statement,CREATE FUNCTION Statement>> | Registers a user-defined function (UDF) written in C as a function within a {project-name} database.
+| <<create_library_statement,CREATE LIBRARY Statement>> | Registers a library object in a {project-name} database.
+| <<create_procedure_statement,CREATE PROCEDURE Statement>> | Registers a Java method as a stored procedure in Java (SPJ) within a {project-name} database.
+| <<drop_function_statement,DROP FUNCTION Statement>> | Removes a user-defined function (UDF) from the {project-name} database.
+| <<drop_library_statement,DROP LIBRARY Statement>> | Removes a library object from the {project-name} database and also removes the library file
referenced by the library object.
-| <<drop_procedure_statement,DROP PROCEDURE Statement>> | Removes a stored procedure in Java (SPJ) from the Trafodion database.
+| <<drop_procedure_statement,DROP PROCEDURE Statement>> | Removes a stored procedure in Java (SPJ) from the {project-name} database.
| <<grant_statement,GRANT Statement>> | Grants privileges for accessing a library object or executing an SPJ or UDF to specified users.
| <<revoke_statement,REVOKE Statement>> | Revokes privileges for accessing a library object or executing an SPJ or UDF from specified users.
UDF from specified users.
@@ -217,11 +217,11 @@ Use these statements to display information about database objects or query exec
| Statement | What It Does
| <<explain_statement,EXPLAIN Statement>> | Displays information contained in the query execution plan.
| <<get_statement,GET Statement>> | Displays the names of database objects, components, component
-privileges, roles, or users that exist in the Trafodion instance.
+privileges, roles, or users that exist in the {project-name} instance.
| <<get_hbase_objects_statement,GET HBASE OBJECTS Statement>> | Displays a list of HBase objects through an SQL interface
-| <<get_version_of_metadata_statement,GET VERSION OF METADATA Statement>> | Displays the version of the metadata in the Trafodion instance and
+| <<get_version_of_metadata_statement,GET VERSION OF METADATA Statement>> | Displays the version of the metadata in the {project-name} instance and
indicates if the metadata is current.
-| <<get_version_of_software_statement,GET VERSION OF SOFTWARE Statement>> | Displays the version of the Trafodion software that is installed on the
+| <<get_version_of_software_statement,GET VERSION OF SOFTWARE Statement>> | Displays the version of the {project-name} software that is installed on the
system and indicates if it is current.
| <<invoke_statement,INVOKE Statement>> | Generates a record description that corresponds to a row in the
specified table or view.
@@ -240,10 +240,10 @@ within a table. These statistics are used to devise optimized access plans.
[[alter_library_statement]]
== ALTER LIBRARY Statement
-The ALTER LIBRARY statement updates the physical filename for a library object in a Trafodion database.
+The ALTER LIBRARY statement updates the physical filename for a library object in a {project-name} database.
A library object can be an SPJ's JAR file or a UDF's library file.
-ALTER LIBRARY is a Trafodion SQL extension.
+ALTER LIBRARY is a {project-name} SQL extension.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement inside
user-defined transaction (`BEGIN WORK…COMMIT WORK`) or when AUTOCOMMIT is OFF. To run this statement, AUTOCOMMIT must be
@@ -312,7 +312,7 @@ ALTER LIBRARY myudfs FILE $TMUDFLIB;
[[alter_table_statement]]
== ALTER TABLE Statement
-The ALTER TABLE statement changes a Trafodion SQL table. See <<Tables,Tables>>.
+The ALTER TABLE statement changes a {project-name} SQL table. See <<Tables,Tables>>.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this
statement inside a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF.
@@ -410,7 +410,7 @@ The clauses for the _column-definition_ are:
** `_column-name_`
+
specifies the name for the new column in the table. _column-name_ is an SQL identifier. _column-name_ must be
-unique among column names in the table. If the column name is a Trafodion SQL reserved word, you must
+unique among column names in the table. If the column name is a {project-name} SQL reserved word, you must
delimit it by enclosing it in double quotes. For example: `"sql".myview`. See <<Identifiers,Identifiers>>.
** `_data-type_`
@@ -422,10 +422,10 @@ If a default is not specified, NULL is used.
+
specifies a default value for the column or specifies that the column does not have a default value. You can declare the default value
explicitly by using the DEFAULT clause, or you can enable null to be used as the default by omitting both the DEFAULT and NOT NULL clauses.
-If you omit the DEFAULT clause and specify NOT NULL, Trafodion SQL returns an error. For existing rows of the table, the added column takes
+If you omit the DEFAULT clause and specify NOT NULL, {project-name} SQL returns an error. For existing rows of the table, the added column takes
on its default value.
+
-If you set the default to the datetime value CURRENT_DATE, CURRENT_TIME, or CURRENT_TIMESTAMP, Trafodion SQL uses January 1, 1 A.D.
+If you set the default to the datetime value CURRENT_DATE, CURRENT_TIME, or CURRENT_TIMESTAMP, {project-name} SQL uses January 1, 1 A.D.
12:00:00.000000 as the default date and time for the existing rows.
+
For any row that you add after the column is added, if no value is specified for the column as part of the add row operation, the column
@@ -619,7 +619,7 @@ ALTER TABLE persnl.project
The ALTER USER statement changes attributes associated with a user who is registered in the database.
-ALTER USER is a Trafodion SQL extension.
+ALTER USER is a {project-name} SQL extension.
```
ALTER USER database-username alter-action[, alter-action]
@@ -695,7 +695,7 @@ The BEGIN WORK statement enables you to start a transaction explicitly\u2014where t
defined by the sequence of SQL statements that begins immediately after BEGIN WORK and ends with the next COMMIT or ROLLBACK
statement. See <<Transaction_Management,Transaction Management>>. BEGIN WORK will raise an error if a transaction is currently active.
-BEGIN WORK is a Trafodion SQL extension.
+BEGIN WORK is a {project-name} SQL extension.
```
BEGIN WORK
@@ -739,7 +739,7 @@ COMMIT WORK;
[[call_statement]]
== CALL Statement
-The CALL statement invokes a stored procedure in Java (SPJ) in a Trafodion SQL database.
+The CALL statement invokes a stored procedure in Java (SPJ) in a {project-name} SQL database.
```
CALL procedure-ref ([argument-list])
@@ -805,7 +805,7 @@ To issue a CALL statement, one of the following must be true:
* You have the EXECUTE (or ALL) privileges, either directly through your username or through a granted role.
For more information, see the <<GRANT_Statement,GRANT Statement>>.
-When the stored procedure executes, it executes as the Trafodion ID.
+When the stored procedure executes, it executes as the {project-name} ID.
<<<
[[call_input_parameter_argument]]
@@ -834,7 +834,7 @@ calling application defines the semantics of the OUT and INOUT parameters in its
[[call_data_conversion_parameter_arguments]]
==== Data Conversion of Parameter Arguments
-Trafodion SQL performs an implicit data conversion when the data type of a parameter argument is compatible with
+{project-name} SQL performs an implicit data conversion when the data type of a parameter argument is compatible with
but does not match the formal data type of the stored procedure. For stored procedure input values,
the conversion is from the actual argument value to the formal parameter type. For stored procedure output values,
the conversion is from the actual output value, which has the data type of the formal parameter, to the declared
@@ -844,7 +844,7 @@ type of the dynamic parameter.
==== Null Input and Output
You can pass a null value as input to or output from an SPJ, provided that the corresponding Java data type of the
-parameter supports nulls. If a null is input or output for a parameter that does not support nulls, Trafodion SQL
+parameter supports nulls. If a null is input or output for a parameter that does not support nulls, {project-name} SQL
returns an error.
<<<
@@ -978,7 +978,7 @@ The CONTROL QUERY CANCEL statement cancels an executing query that you identify
You can execute the CONTROL QUERY CANCEL statement in a client-based tool like TrafCI or through any ODBC or JDBC
application.
-CONTROL QUERY CANCEL is a Trafodion SQL extension.
+CONTROL QUERY CANCEL is a {project-name} SQL extension.
```
CONTROL QUERY CANCEL QID query-id [COMMENT 'comment-text']
@@ -1017,11 +1017,11 @@ executing query no longer affect other clients sharing the same connection.
==== Restrictions on CONTROL QUERY CANCEL
Some executing queries may not respond to a CONTROL QUERY CANCEL statement within a 60-second interval. For those
-queries, Trafodion SQL stops their ESP processes if there are any. If this action allows the query to be canceled,
+queries, {project-name} SQL stops their ESP processes if there are any. If this action allows the query to be canceled,
you will see all the benefits listed above.
If the executing query does not terminate within 120 seconds after the CONTROL QUERY CANCEL statement is issued,
-Trafodion SQL stops the master executor process, terminating the query and generating a lost connection error.
+{project-name} SQL stops the master executor process, terminating the query and generating a lost connection error.
In this case, you will not see any of the benefits listed above. Instead, you will lose your connection and will
need to reconnect and re-prepare the query. This situation often occurs with the CALL, DDL, and utility statements
and rarely with other statements.
@@ -1072,7 +1072,7 @@ error message indicating that the query has been canceled:
The CONTROL QUERY DEFAULT statement changes the default settings for the current process. You can execute
the CONTROL QUERY DEFAULT statement in a client-based tool like TrafCI or through any ODBC or JDBC application.
-CONTROL QUERY DEFAULT is a Trafodion SQL extension.
+CONTROL QUERY DEFAULT is a {project-name} SQL extension.
```
{ CONTROL QUERY DEFAULT | CQD } control-default-option
@@ -1087,7 +1087,7 @@ control-default-option is:
* `_attribute_`
+
is a character string that represents an attribute name. For descriptions of these attributes,
-see the http://trafodion.incubator.apache.org/docs/cqd_reference/index.html[Trafodion Control Query Default (CQD) Reference Guide].
+see the {docs-url}/cqd_reference/index.html[{project-name} Control Query Default (CQD) Reference Guide].
* `_attr-value_`
+
@@ -1141,7 +1141,7 @@ CONTROL QUERY DEFAULT CACHE_HISTOGRAMS_REFRESH_INTERVAL RESET;
== CREATE FUNCTION Statement
The CREATE FUNCTION statement registers a user-defined function (UDF) written in C as a function within
-a Trafodion database. Currently, Trafodion supports the creation of _scalar UDFs_, which return a single
+a {project-name} database. Currently, {project-name} supports the creation of _scalar UDFs_, which return a single
value or row when invoked. Scalar UDFs are invoked as SQL expressions in the SELECT list or WHERE clause
of a SELECT statement.
@@ -1342,7 +1342,7 @@ The CREATE INDEX statement creates an SQL index based on one or more columns of
The CREATE VOLATILE INDEX statement creates an SQL index with a lifespan that is limited to the SQL session that
the index is created. Volatile indexes are dropped automatically when the session ends. See <<Indexes,Indexes>>.
-CREATE INDEX is a Trafodion SQL extension.
+CREATE INDEX is a {project-name} SQL extension.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement
inside a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run this statement,
@@ -1501,10 +1501,10 @@ ON persnl.employee (last_name, first_name);
[[create_library_statement]]
== CREATE LIBRARY Statement
-The CREATE LIBRARY statement registers a library object in a Trafodion database. A library object
+The CREATE LIBRARY statement registers a library object in a {project-name} database. A library object
can be an SPJ's JAR file or a UDF's library file.
-CREATE LIBRARY is a Trafodion SQL extension.
+CREATE LIBRARY is a {project-name} SQL extension.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run
this statement inside a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT
@@ -1587,7 +1587,7 @@ CREATE LIBRARY myudfs FILE $UDFLIB;
[[create_procedure_statement]]
== CREATE PROCEDURE Statement
-The CREATE PROCEDURE statement registers a Java method as a stored procedure in Java (SPJ) within a Trafodion database.
+The CREATE PROCEDURE statement registers a Java method as a stored procedure in Java (SPJ) within a {project-name} database.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement
inside a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run this statement,
@@ -1655,11 +1655,11 @@ specifies an ANSI logical name of the form:
where each part of the name is a valid SQL identifier with a maximum of 128 characters. For more information,
see <<identifiers,identifiers>> and <<database_object_names,database object names>>.
+
-specify a name that is unique and does not exist for any procedure or function in the same schema. Trafodion
+specify a name that is unique and does not exist for any procedure or function in the same schema. {project-name}
does not support the overloading of procedure names. That is, you cannot register the same procedure name more than
once with different underlying SPJ methods.
+
-If you do not fully qualify the procedure name, then Trafodion qualifies it according to the schema of the current session.
+If you do not fully qualify the procedure name, then {project-name} qualifies it according to the schema of the current session.
** `_sql-parameter_`
+
@@ -1762,7 +1762,7 @@ Specifies a mappable Java data type. For the mapping of the Java data types to S
* `library \[[_catalog-name_.]_schema-name_.]_library-name_`
+
specifies the ANSI logical name of a library containing the SPJ method. If you do not fully qualify the library name,
-then Trafodion qualifies it according to the schema of the current session.
+then {project-name} qualifies it according to the schema of the current session.
* `external security _external-security-type_`
+
@@ -1826,13 +1826,13 @@ procedure\u2019s transaction attribute to no transaction required. For more informa
+
specifies whether the SPJ always returns the same values for out and inout parameters for a given set of argument values
(`deterministic`) or does not return the same values (`not deterministic`, the default option). If you specify `deterministic`,
-Trafodion is not required to call the SPJ each time to produce results; instead, Trafodion caches the results and
+{project-name} is not required to call the SPJ each time to produce results; instead, {project-name} caches the results and
reuses them during subsequent calls, thus optimizing the CALL statement.
* `no isolate | isolate`
+
specifies that the SPJ executes either in the environment of the database server (`no isolate`) or in an isolated environment
-(`isolate`, the default option). Trafodion allows both options but always executes the SPJ in the UDR server process (`isolate`).
+(`isolate`, the default option). {project-name} allows both options but always executes the SPJ in the UDR server process (`isolate`).
[[create_procedure_considerations]]
=== Considerations for CREATE PROCEDURE
@@ -1924,7 +1924,7 @@ CREATE PROCEDURE lowerprice()
MODIFIES SQL DATA;
```
+
-Because the procedure name is not qualified by a catalog and schema, Trafodion qualifies it according to the current
+Because the procedure name is not qualified by a catalog and schema, {project-name} qualifies it according to the current
session settings, where the catalog is TRAFODION (by default) and the schema is set to SALES. Since the procedure needs
to be able to read and modify SQL data, MODIFIES SQL DATA is specified in the CREATE PROCEDURE statement.
+
@@ -2137,7 +2137,7 @@ schema-clause is:
indicates whether access to the schema is restricted to the authorization ID by default (PRIVATE) or whether
any database user may add objects to the schema (SHARED). The default class is PRIVATE.
+
-NOTE: Schemas created in Trafodion Release 0.9 or earlier are SHARED schemas.
+NOTE: Schemas created in {project-name} Release 0.9 or earlier are SHARED schemas.
* `_schema-name_`
+
@@ -2164,7 +2164,7 @@ Schema names that begin with a leading underscore (_) are reserved for future us
The AUTHORIZATION clause is optional. If you omit this clause, the current user becomes the schema owner.
-NOTE: An authorization ID is assigned to a schema name even if authorization is not enabled for the Trafodion database.
+NOTE: An authorization ID is assigned to a schema name even if authorization is not enabled for the {project-name} database.
However, no enforcement occurs unless authorization is enabled.
The schema owner can perform operations on the schema and on objects within the schema. For example:
@@ -2222,8 +2222,8 @@ CREATE PRIVATE SCHEMA AUTHORIZATION JSmith;
[[create_table_statement]]
== CREATE TABLE Statement
-The CREATE TABLE statement creates a Trafodion SQL table, which is a mapping of a relational SQL table to an HBase table.
-The CREATE VOLATILE TABLE statement creates a temporary Trafodion SQL table that exists only during an SQL session. The
+The CREATE TABLE statement creates a {project-name} SQL table, which is a mapping of a relational SQL table to an HBase table.
+The CREATE VOLATILE TABLE statement creates a temporary {project-name} SQL table that exists only during an SQL session. The
CREATE TABLE AS statement creates a table based on the data attributes of a SELECT query and populates the table using the
data returned by the SELECT query. See <<tables,Tables>>.
@@ -2420,7 +2420,7 @@ specifies a select query which is used to populate the created table. A select q
specifies the name and data type for a column in the table. At least one column definition is required in a
CREATE TABLE statement.
-** _column_ is an SQL identifier. _column_ must be unique among column names in the table. If the name is a Trafodion
+** _column_ is an SQL identifier. _column_ must be unique among column names in the table. If the name is a {project-name}
SQL reserved word, you must delimit it by enclosing it in double quotes. Such delimited parts are case-sensitive.
For example: "join".
@@ -2442,7 +2442,7 @@ See <<default_clause,DEFAULT Clause>>.
+
specifies a name for the column or table constraint. _constraint-name_ must have the same schema as _table_ and must be
unique among constraint names in its schema. If you omit the schema portions of the name you specify in _constraint-name_,
-Trafodion SQL expands the constraint name by using the schema for _table_. See <<constraint_names,Constraint Names>> and
+{project-name} SQL expands the constraint name by using the schema for _table_. See <<constraint_names,Constraint Names>> and
<<database_object_names,Database Object Names>>.
* `NOT NULL`
@@ -2462,7 +2462,7 @@ part of the PRIMARY KEY.
specify on a UNIQUE constraint cannot match the set of columns on any other UNIQUE constraint for the table or on the
PRIMARY KEY constraint for the table. All columns defined as unique must be specified as NOT NULL.
+
-A UNIQUE constraint is enforced with a unique index. If there is already a unique index on _column-list_, Trafodion SQL
+A UNIQUE constraint is enforced with a unique index. If there is already a unique index on _column-list_, {project-name} SQL
uses that index. If a unique index does not exist, the system creates a unique index.
* `PRIMARY KEY [ASC[ENDING] | DESC[ENDING]], or, PRIMARY KEY (_key-column-list_)`
@@ -2475,10 +2475,10 @@ ASCENDING and DESCENDING specify the direction for entries in one column within
The PRIMARY KEY value in each row of the table must be unique within the table. A PRIMARY KEY defined for a set of columns
implies that the column values are unique and not null. You can specify PRIMARY KEY only once on any CREATE TABLE statement.
+
-Trafodion SQL uses the primary key as the clustering key of the table to avoid creating a separate, unique index to implement
+{project-name} SQL uses the primary key as the clustering key of the table to avoid creating a separate, unique index to implement
the primary key constraint.
+
-A PRIMARY KEY constraint is required in Trafodion SQL.
+A PRIMARY KEY constraint is required in {project-name} SQL.
<<<
* `CHECK (_condition_)`
@@ -2521,7 +2521,7 @@ set of columns specified in the FOREIGN KEY clause. For information about _ref-s
<<<
* `LIKE _source-table_ [_include-option_]…`
+
-directs Trafodion SQL to create a table like the existing table, _source-table_, omitting constraints (with the exception of the NOT
+directs {project-name} SQL to create a table like the existing table, _source-table_, omitting constraints (with the exception of the NOT
NULL and PRIMARY KEY constraints) and partitions unless the _include-option_ clauses are specified.
** `_source-table_`
@@ -2532,16 +2532,16 @@ is the ANSI logical name for the existing table and must be unique among names o
*** `WITH CONSTRAINTS`
+
-directs Trafodion SQL to use constraints from _source-table_. Constraint names for _table_ are randomly generated unique names.
+directs {project-name} SQL to use constraints from _source-table_. Constraint names for _table_ are randomly generated unique names.
+
When you perform a CREATE TABLE LIKE, whether or not you include the WITH CONSTRAINTS clause, the target table will have all
the NOT NULL column constraints that exist for the source table with different constraint names.
*** `WITH PARTITIONS`
+
-directs Trafodion SQL to use partition definitions from _source-table_. Each new table partition resides on the same volume
+directs {project-name} SQL to use partition definitions from _source-table_. Each new table partition resides on the same volume
as its original _source-table_ counterpart. The new table partitions do not inherit partition names from the original table.
-Instead, Trafodion SQL generates new names based on the physical file location.
+Instead, {project-name} SQL generates new names based on the physical file location.
+
If you specify the LIKE clause and the SALT USING _num_ PARTITIONS clause, you cannot specify WITH PARTITIONS.
@@ -2598,14 +2598,14 @@ UPDATE STATISTICS.
* Volatile tables can be created and accessed using one-part, two-part, or three-part names. However, you must use the
same name (one part, two part, or three part) for any further DDL or DML statements on the created volatile table.
See <<create_table_examples,Examples of CREATE TABLE>>.
-* Trafodion SQL allows users to explicitly specify primary key and STORE BY clauses on columns that contain null values.
+* {project-name} SQL allows users to explicitly specify primary key and STORE BY clauses on columns that contain null values.
<<<
-* Trafodion SQL does not require that the first column in a volatile table contain not null values and be the primary key.
-Instead, Trafodion SQL attempts to partition the table, if possible, using an appropriate suitable key column as the
+* {project-name} SQL does not require that the first column in a volatile table contain not null values and be the primary key.
+Instead, {project-name} SQL attempts to partition the table, if possible, using an appropriate suitable key column as the
primary and partitioning key. For more information,
see <<create_table_how_trafodion_sql_selects_suitable_keys_for_volatile_tables,
-How Trafodion SQL Selects Suitable Keys for Volatile Tables>>.
+How {project-name} SQL Selects Suitable Keys for Volatile Tables>>.
[[create_table_restrictions_for_create_volatile_table]]
===== Restrictions for CREATE VOLATILE TABLE
@@ -2619,16 +2619,16 @@ These items are not supported for volatile tables:
* CREATE TABLE LIKE operations
[[create_table_how_trafodion_sql_supports_nullable_keys_for_volatile_tables]]
-===== How Trafodion SQL Supports Nullable Keys for Volatile Tables
+===== How {project-name} SQL Supports Nullable Keys for Volatile Tables
* Allows nullable keys in primary key, STORE BY, and unique constraints.
* A null value is treated as the highest value for that column.
* A null value as equal to other null values and only one value is allowed for that column.
[[create_table_how_trafodion_sql_selects_suitable_keys_for_volatile_tables]]
-===== How Trafodion SQL Selects Suitable Keys for Volatile Tables
+===== How {project-name} SQL Selects Suitable Keys for Volatile Tables
-Trafodion SQL searches for the first suitable column in the list of columns of the table being created. Once the column
+{project-name} SQL searches for the first suitable column in the list of columns of the table being created. Once the column
is located, the table is partitioned on it. The searched columns in the table might be explicitly specified (as in a
CREATE TABLE statement) or implicitly created (as in a CREATE TABLE AS SELECT statement).
@@ -2636,12 +2636,12 @@ The suitable key column is selected only if no primary key or STORE BY clause ha
of these clauses have been specified, they are used to select the key columns.
<<<
-Trafodion SQL follows these guidelines to search for and select suitable keys:
+{project-name} SQL follows these guidelines to search for and select suitable keys:
* A suitable column can be a nullable column.
-* Certain data types in Trafodion SQL cannot be used as a partitioning key. Currently, this includes any floating point
+* Certain data types in {project-name} SQL cannot be used as a partitioning key. Currently, this includes any floating point
columns (REAL, DOUBLE PRECISION, and FLOAT).
-* Trafodion SQL searches for a suitable column according to this predefined order:
+* {project-name} SQL searches for a suitable column according to this predefined order:
** Numeric columns are chosen first, followed by fixed CHAR, DATETIME, INTERVAL, and VARCHAR data types.
** Within numeric data types, the order is binary NUMERIC (LARGEINT, INTEGER, SMALLINT), and DECIMAL.
** An unsigned column is given preference over a signed column.
@@ -2651,7 +2651,7 @@ columns (REAL, DOUBLE PRECISION, and FLOAT).
* If a suitable column is located, it becomes the partitioning key where the primary key is _suitable_column_, SYSKEY.
This causes the table to be partitioned while preventing the duplicate key and null-to-non-null errors.
-The list below shows the order of precedence, from low to high, of data types when Trafodion SQL searches for a suitable
+The list below shows the order of precedence, from low to high, of data types when {project-name} SQL searches for a suitable
key. A data type appearing later has precedence over previously-appearing data types. Data types that do not appear in
the list below cannot be chosen as a key column.
@@ -2706,9 +2706,9 @@ Only one unique null value is allowed:
[[create_table_examples_for_selecting_suitable_keys_for_volatile_tables]]
===== Examples for Selecting Suitable Keys for Volatile Tables
-These examples show the order by which Trafodion SQL selects a suitable key based on the precedence rules described in
+These examples show the order by which {project-name} SQL selects a suitable key based on the precedence rules described in
<<create_table_how_trafodion_sql_selects_suitable_keys_for_volatile_tables,
-How Trafodion SQL Selects Suitable Keys for Volatile Tables>>:
+How {project-name} SQL Selects Suitable Keys for Volatile Tables>>:
* Selects column a as the primary and partitioning key:
+
@@ -2839,9 +2839,9 @@ CREATE TABLE ttgt NO LOAD AS (SELECT ...);
```
[[create_table_trafodion_sql_extensions_to_create_table]]
-=== Trafodion SQL Extensions to CREATE TABLE
+=== {project-name} SQL Extensions to CREATE TABLE
-This statement is supported for compliance with ANSI SQL:1999 Entry Level. Trafodion SQL extensions to the CREATE TABLE
+This statement is supported for compliance with ANSI SQL:1999 Entry Level. {project-name} SQL extensions to the CREATE TABLE
statement are ASCENDING, DESCENDING, and PARTITION clauses. CREATE TABLE LIKE is also an extension.
<<<
@@ -2984,7 +2984,7 @@ CREATE TABLE t2 (c1 int, c2 char (50) UPSHIFT NOT NULL) AS SELECT * FROM t1;
[[create_view_statement]]
== CREATE VIEW Statement
-The CREATE VIEW statement creates a Trafodion SQL view. See <<views,Views>>.
+The CREATE VIEW statement creates a {project-name} SQL view. See <<views,Views>>.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement inside
a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run this statement, AUTOCOMMIT
@@ -3252,13 +3252,13 @@ tables vp0, vp1 and vp2 all have a key column a. This key column is known to con
The three tables vp0, vp1 and vp2 also contain columns b, c and d respectively. We can create a view vp that combines
these three tables and provides the interface of columns a, b, c and d belonging to a single object.
-Trafodion SQL has the ability to eliminate redundant joins in a query. Redundant joins occur when:
+{project-name} SQL has the ability to eliminate redundant joins in a query. Redundant joins occur when:
* Output of join contains expressions from only one of its two children
* Every row from this child will match one and only one row from the other child
Suppose tables A and B denote generic tables. To check if the rule "every row from this child will match one and only one row
-from the other child" is true, Trafodion SQL uses the fact that the join of Table A with table or subquery B preserves all the
+from the other child" is true, {project-name} SQL uses the fact that the join of Table A with table or subquery B preserves all the
rows of A if the join predicate contains an equi-join predicate that references a key of B, and one of the following is true:
The join is a left outer join where B is the inner table. In this example, for the join between vp0 and vp1,vp0 fills the role
of table A and vp1 fills the role of table B. For the join between vp1 and vp2, vp1 fills the role of table A and vp2 fills
@@ -3291,7 +3291,7 @@ The DELETE statement is a DML statement that deletes a row or rows from a table
a view deletes the rows from the table on which the view is based. DELETE does not remove a table or view, even if you
delete the last row in the table or view.
-Trafodion SQL provides searched DELETE\u2014deletes rows whose selection depends on a search condition.
+{project-name} SQL provides searched DELETE\u2014deletes rows whose selection depends on a search condition.
For the searched DELETE form, if no WHERE clause exists, all rows are deleted from the table or view.
@@ -3405,7 +3405,7 @@ delete from table1 where a in (select a from table1 where b > 200)
[[drop_function_statement]]
== DROP FUNCTION Statement
-The DROP FUNCTION statement removes a user-defined function (UDF) from the Trafodion database.
+The DROP FUNCTION statement removes a user-defined function (UDF) from the {project-name} database.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement inside
a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run this statement, AUTOCOMMIT
@@ -3463,8 +3463,8 @@ DROP PROCEDURE reverse;
[[drop_index_statement]]
== DROP INDEX Statement
-The DROP INDEX statement drops a Trafodion SQL index. See <<indexes,Indexes>>.
-DROP INDEX is a Trafodion SQL extension.
+The DROP INDEX statement drops a {project-name} SQL index. See <<indexes,Indexes>>.
+DROP INDEX is a {project-name} SQL extension.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement inside
a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run this statement, AUTOCOMMIT
@@ -3515,10 +3515,10 @@ DROP VOLATILE INDEX vindex;
[[drop_library_statement]]
== DROP LIBRARY Statement
-The DROP LIBRARY statement removes a library object from the Trafodion database and also removes the library file
+The DROP LIBRARY statement removes a library object from the {project-name} database and also removes the library file
referenced by the library object.
-DROP LIBRARY is a Trafodion SQL extension.
+DROP LIBRARY is a {project-name} SQL extension.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement
inside a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run this statement,
@@ -3553,7 +3553,7 @@ the default value is restrict.
* RESTRICT requires that all procedures and functions that refer to the library object be dropped before you drop the
library object. CASCADE automatically drops any procedures or functions that are using the library.
-* If the library filename referenced by the library object does not exist, Trafodion SQL issues a warning.
+* If the library filename referenced by the library object does not exist, {project-name} SQL issues a warning.
[[drop_library_required_privileges]]
==== Required Privileges
@@ -3588,7 +3588,7 @@ this library. If any UDFs were created based on this library, the DROP LIBRARY o
[[drop_procedure_statement]]
== DROP PROCEDURE Statement
-The DROP PROCEDURE statement removes a stored procedure in Java (SPJ) from the Trafodion database.
+The DROP PROCEDURE statement removes a stored procedure in Java (SPJ) from the {project-name} database.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement inside
a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run this statement, AUTOCOMMIT
@@ -3791,7 +3791,7 @@ DROP SCHEMA sales;
[[drop_table_statement]]
== DROP TABLE Statement
-The DROP TABLE statement deletes a Trafodion SQL table and its dependent objects such as indexes and constraints.
+The DROP TABLE statement deletes a {project-name} SQL table and its dependent objects such as indexes and constraints.
See <<tables,Tables>>.
NOTE: DDL statements are not currently supported in transactions. That
@@ -3860,7 +3860,7 @@ DROP VOLATILE TABLE vtable;
[[drop_view_statement]]
== DROP VIEW Statement
-The DROP VIEW statement deletes a Trafodion SQL view. See <<views,Views>>.
+The DROP VIEW statement deletes a {project-name} SQL view. See <<views,Views>>.
NOTE: DDL statements are not currently supported in transactions. That means that you cannot run this statement inside
a user-defined transaction (BEGIN WORK…COMMIT WORK) or when AUTOCOMMIT is OFF. To run this statement, AUTOCOMMIT
@@ -3912,7 +3912,7 @@ DROP VIEW mysch.myview;
[[execute_statement]]
== Execute Statement
-The EXECUTE statement executes an SQL statement previously compiled by a PREPARE statement in a Trafodion Command Interface
+The EXECUTE statement executes an SQL statement previously compiled by a PREPARE statement in a {project-name} Command Interface
(TrafCI) session.
```
@@ -3941,20 +3941,20 @@ the data type of the associated parameter in the prepared statement.
+
Parameter values (_param_) are substituted for unnamed parameters in the prepared statement by position\u2014the i-th value
in the USING clause is the value for the i-th parameter in the statement. If fewer parameter values exist in the USING
-clause than unnamed parameters in the PREPARE statement, Trafodion SQL returns an error. If more parameter values exist
-in the USING clause than the unnamed parameters in the PREPARE statement, Trafodion SQL issues warning 15019.
+clause than unnamed parameters in the PREPARE statement, {project-name} SQL returns an error. If more parameter values exist
+in the USING clause than the unnamed parameters in the PREPARE statement, {project-name} SQL issues warning 15019.
+
<<<
+
The USING clause does not set parameter values for named parameters (represented by ?_param-name_) in a prepared statement.
To set parameter values for named parameters, use the SET PARAM command. For more information, see the
-http://trafodion.incubator.apache.org/docs/command_interface/index.html[_Trafodion Command Interface Guide_].
+{docs-url}/command_interface/index.html[_{project-name} Command Interface Guide_].
** `?_param-name_`
+
The value for a ?_param-name_ must be previously specified with the SET PARAM command. The _param-name_ is case-sensitive.
For information about the SET PARAM command, see the
-http://trafodion.incubator.apache.org/docs/command_interface/index.html[_Trafodion Command Interface Guide_].
+{docs-url}/command_interface/index.html[_{project-name} Command Interface Guide_].
** `_literal-value_`
+
@@ -3966,7 +3966,7 @@ _literal-value_ contains leading or trailing spaces, commas, or if it matches an
set, enclose the _literal-value_ in single quotes.
See the <<prepare_statement,PREPARE Statement>>. For information about the SET PARAM command, see the
-http://trafodion.incubator.apache.org/docs/command_interface/index.html[_Trafodion Command Interface Guide_].
+{docs-url}/command_interface/index.html[_{project-name} Command Interface Guide_].
[[execute_considerations]]
=== Considerations for EXECUTE
@@ -4070,7 +4070,7 @@ The EXPLAIN statement helps you to review query execution plans. You can use the
execute other SQL statements (for example, SELECT). For more information on the EXPLAIN function, see
<<"explain_function","EXPLAIN Function">>.
-EXPLAIN is a Trafodion SQL extension.
+EXPLAIN is a {project-name} SQL extension.
```
EXPLAIN [OPTIONS {'f'}] {FOR QID query-text | prepared-stmt-name}
@@ -4116,8 +4116,8 @@ to PUBLIC by default.
[[explain_obtaining_explain_plans]]
==== Obtaining EXPLAIN Plans While Queries Are Running
-Trafodion SQL provides the ability to capture an EXPLAIN plan for a query at any time while the query is running
-with the FOR QID option. By default, this behavior is disabled for a Trafodion database session.
+{project-name} SQL provides the ability to capture an EXPLAIN plan for a query at any time while the query is running
+with the FOR QID option. By default, this behavior is disabled for a {project-name} database session.
NOTE: Enable this feature before you start preparing and executing queries.
@@ -4190,9 +4190,9 @@ EXPLAIN options 'f' q;
== GET Statement
The GET statement displays the names of database objects, components, component privileges, roles, or users that exist
-in the Trafodion instance.
+in the {project-name} instance.
-GET is a Trafodion SQL extension.
+GET is a {project-name} SQL extension.
```
GET option
@@ -4330,8 +4330,8 @@ only trafodion.
=== Considerations for GET
IMPORTANT: The GET COMPONENT PRIVILEGES, GET COMPONENTS, GET ROLES FOR USER, and GET USERS FOR ROLE statements work only when
-authentication and authorization are enabled in Trafodion. For more information, see
-http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure Trafodion].
+authentication and authorization are enabled in {project-name}. For more information, see
+http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure {project-name}].
The GET statement displays delimited object names in their internal format. For example, the GET statement returns the delimited
name "my ""table""" as my "table".
@@ -4495,11 +4495,11 @@ get users for role db rootrole;
[[get_hbase_objects_statement]]
== GET HBASE OBJECTS Statement
-The GET HBASE OBJECTS statement displays a list of HBase objects directly from HBase, not from the Trafodion metadata,
-and it can be run in any SQL interface, such as the Trafodion Command Interface (TrafCI). This command is equivalent
+The GET HBASE OBJECTS statement displays a list of HBase objects directly from HBase, not from the {project-name} metadata,
+and it can be run in any SQL interface, such as the {project-name} Command Interface (TrafCI). This command is equivalent
to running a list command from an HBase shell, but without having to start and connect to an HBase shell.
-GET HBASE OBJECTS is a Trafodion SQL extension.
+GET HBASE OBJECTS is a {project-name} SQL extension.
```
GET [ USER | SYSTEM | EXTERNAL | ALL } HBASE OBJECTS
@@ -4510,16 +4510,16 @@ GET [ USER | SYSTEM | EXTERNAL | ALL } HBASE OBJECTS
* `USER`
+
-displays a list of the Trafodion user objects.
+displays a list of the {project-name} user objects.
* `SYSTEM`
+
-displays a list of the Trafodion system objects, such as metadata, repository, privileges, and Distributed Transaction
+displays a list of the {project-name} system objects, such as metadata, repository, privileges, and Distributed Transaction
Manager (DTM) tables.
* `EXTERNAL`
+
-displays a list of non-Trafodion objects.
+displays a list of non-{project-name} objects.
* `ALL`
+
@@ -4529,10 +4529,10 @@ displays a list of all objects, including user, system, and external objects.
[[get_hbase_objects_examples]]
=== Examples of GET HBASE OBJECTS
-* This GET HBASE OBJECTS statement displays the Trafodion user objects in HBase:
+* This GET HBASE OBJECTS statement displays the {project-name} user objects in HBase:
+
```
-Trafodion Conversational Interface 1.1.0
+{project-name} Conversational Interface 1.1.0
(c) Copyright 2014 Hewlett-Packard Development Company, LP.
>>get user hbase objects;
@@ -4555,7 +4555,7 @@ TRAFODION.SCH.X3
```
<<<
-* This GET HBASE OBJECTS statement displays the Trafodion system objects in HBase:
+* This GET HBASE OBJECTS statement displays the {project-name} system objects in HBase:
+
```
>>get system hbase objects;
@@ -4589,7 +4589,7 @@ TRAFODION._REPOS_.METRIC_TEXT_TABLE
--- SQL operation complete.
```
-* This GET HBASE OBJECTS statement displays the external, non-Trafodion objects in HBase:
+* This GET HBASE OBJECTS statement displays the external, non-{project-name} objects in HBase:
+
```
>>get external hbase objects;
@@ -4604,10 +4604,10 @@ obj2
[[get_version_of_metadata_statement]]
== GET VERSION OF METADATA Statement
-The GET VERSION OF METADATA statement displays the version of the metadata in the Trafodion instance and indicates if
+The GET VERSION OF METADATA statement displays the version of the metadata in the {project-name} instance and indicates if
the metadata is current.
-GET VERSION OF METADATA is a Trafodion SQL extension.
+GET VERSION OF METADATA is a {project-name} SQL extension.
```
GET VERSION OF METADATA
@@ -4616,7 +4616,7 @@ GET VERSION OF METADATA
[[get_version_of_metadata_considerations]]
=== Considerations for GET VERSION OF METADATA
-* If the metadata is compatible with the installed Trafodion software version, the GET VERSION OF METADATA statement
+* If the metadata is compatible with the installed {project-name} software version, the GET VERSION OF METADATA statement
indicates that the metadata is current:
+
```
@@ -4624,7 +4624,7 @@ Current Version 3.0. Expected Version 3.0.
Metadata is current.
```
-* If the metadata is incompatible with the installed Trafodion software version, the GET VERSION OF METADATA statement
+* If the metadata is incompatible with the installed {project-name} software version, the GET VERSION OF METADATA statement
indicates that you need to upgrade or reinitialize the metadata:
+
```
@@ -4635,7 +4635,7 @@ Current Version 2.3. Expected Version 3.0.
[[get_version_of_metadata_examples]]
=== Examples of GET VERSION OF METADATA
-* This GET VERSION OF METADATA statement displays the metadata version in a Trafodion Release 1.0.0 instance:
+* This GET VERSION OF METADATA statement displays the metadata version in a {project-name} Release 1.0.0 instance:
+
```
>> get version of metadata;
@@ -4646,7 +4646,7 @@ Current Version 2.3. Expected Version 3.0.
```
<<<
-* This GET VERSION OF METADATA statement displays the metadata version in a Trafodion Release 0.9.0 instance:
+* This GET VERSION OF METADATA statement displays the metadata version in a {project-name} Release 0.9.0 instance:
+
```
>> get version of metadata;
@@ -4656,7 +4656,7 @@ Current Version 2.3. Expected Version 3.0.
--- SQL operation complete.
```
-* If the metadata is incompatible with the installed Trafodion software version, you will see this output indicating
+* If the metadata is incompatible with the installed {project-name} software version, you will see this output indicating
that you need to upgrade or reinitialize the metadata:
+
```
@@ -4671,10 +4671,10 @@ get version of metadata;
[[get_version_of_software_statement]]
== GET VERSION OF SOFTWARE Statement
-The GET VERSION OF SOFTWARE statement displays the version of the Trafodion software that is installed on the system and
+The GET VERSION OF SOFTWARE statement displays the version of the {project-name} software that is installed on the system and
indicates if it is current.
-GET VERSION OF SOFTWARE is a Trafodion SQL extension.
+GET VERSION OF SOFTWARE is a {project-name} SQL extension.
```
GET VERSION OF SOFTWARE
@@ -4690,7 +4690,7 @@ System Version 1.0.0. Expected Version 1.0.0.
Software is current.
```
-* In rare circumstances where something went wrong with the Trafodion software installation and mismatched objects were
+* In rare circumstances where something went wrong with the {project-name} software installation and mismatched objects were
installed, the GET VERSION OF SOFTWARE statement displays this output:
+
```
@@ -4702,7 +4702,7 @@ System Version 0.9.1. Expected Version 1.0.0.
[[get_version_of_software_examples]]
=== Examples of GET VERSION OF SOFTWARE
-* This GET VERSION OF SOFTWARE statement displays the software version for Trafodion Release 1.0.0:
+* This GET VERSION OF SOFTWARE statement displays the software version for {project-name} Release 1.0.0:
+
```
>> get version of software;
@@ -4712,7 +4712,7 @@ System Version 1.0.0. Expected Version 1.0.0.
--- SQL operation complete.
```
-* This GET VERSION OF SOFTWARE statement displays the software version for Trafodion Release 0.9.0:
+* This GET VERSION OF SOFTWARE statement displays the software version for {project-name} Release 0.9.0:
+
```
get version of software;
@@ -4723,7 +4723,7 @@ System Version 0.9.0. Expected Version 0.9.0.
--- SQL operation complete.
```
-* If something went wrong with the Trafodion software installation and if mismatched objects were installed, you will
+* If something went wrong with the {project-name} software installation and if mismatched objects were installed, you will
see this output indicating that the software being used is incompatible with the software on the system:
+
```
@@ -4743,8 +4743,8 @@ System Version 0.9.1. Expected Version 1.0.0.
The GRANT statement grants access privileges on an SQL object to specified users or roles.
IMPORTANT: This statement works only when authentication and
-authorization are enabled in Trafodion. For more information, see
-http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure Trafodion].
+authorization are enabled in {project-name}. For more information, see
+http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure {project-name}].
```
GRANT {privilege [,privilege]... |ALL [PRIVILEGES]}
@@ -4876,10 +4876,10 @@ GRANT SELECT ON TABLE invent.partloc TO ajones;
The GRANT COMPONENT PRIVILEGE statement grants one or more component privileges to a user or role. See <<"Privileges","Privileges">> and <<"Roles","Roles">>.
-GRANT COMPONENT PRIVILEGE is a Trafodion SQL extension.
+GRANT COMPONENT PRIVILEGE is a {project-name} SQL extension.
-IMPORTANT: This statement works only when authentication and authorization are enabled in Trafodion. For more information, see
-http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure Trafodion].
+IMPORTANT: This statement works only when authentication and authorization are enabled in {project-name}. For more information, see
+http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure {project-name}].
```
GRANT COMPONENT PRIVILEGE {privilege-name [, privilege-name]...}
@@ -5000,8 +5000,8 @@ GRANT COMPONENT PRIVILEGE CREATE_TABLE ON SQL_OPERATIONS TO sqluser1;
The GRANT ROLE statement grants one or more roles to a user. See <<roles,Roles>>.
-IMPORTANT: This statement works only when authentication and authorization are enabled in Trafodion. For more information,
-see http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure Trafodion].
+IMPORTANT: This statement works only when authentication and authorization are enabled in {project-name}. For more information,
+see http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure {project-name}].
```
GRANT ROLE {role-name [,role-name ]...}
@@ -5175,7 +5175,7 @@ year-month or both day-time intervals.
===== Inserting Date and Time Values
-Date, time, and timestamp are the three Trafodion SQL datetime data types. A value with a datetime data type is compatible
+Date, time, and timestamp are the three {project-name} SQL datetime data types. A value with a datetime data type is compatible
with another value with a datetime data type only if the values have the same datetime fields.
===== Inserting Nulls
@@ -5317,7 +5317,7 @@ The record description includes a data item for each column in the table, view,
excluding the SYSKEY column. It includes the SYSKEY column of a view only if the view explicitly listed the column in its
definition.
-INVOKE is a Trafodion SQL extension.
+INVOKE is a {project-name} SQL extension.
```
INVOKE table-name
@@ -5351,7 +5351,7 @@ To issue an INVOKE statement, one of the following must be true:
+
```
SQL> invoke trafodion.seabase.t;
--- Definition of Trafodion table TRAFODION.SEABASE.T
+-- Definition of {project-name} table TRAFODION.SEABASE.T
-- Definition current Wed Mar 5 10:36:06 2014
(
A INT NO DEFAULT NOT NULL NOT DROPPABLE
@@ -5568,7 +5568,7 @@ MERGE INTO t USING
[[prepare_statement]]
== PREPARE Statement
-The PREPARE statement compiles an SQL statement for later use with the EXECUTE statement in the same Trafodion Command
+The PREPARE statement compiles an SQL statement for later use with the EXECUTE statement in the same {project-name} Command
Interface (TrafCI) session.
You can also use PREPARE to check the syntax of a statement without executing the statement in the same TrafCI session.
@@ -5675,7 +5675,7 @@ For more information, see the <<execute_statement,EXECUTE Statement>>.
The REGISTER USER statement registers a user in the SQL database, associating the user's login name with a database username.
-REGISTER USER is a Trafodion SQL extension.
+REGISTER USER is a {project-name} SQL extension.
NOTE: The user's login name is also the name by which the user is defined in the directory service, so the syntax description
below refers to it as the _directory-service username_.
@@ -5690,7 +5690,7 @@ REGISTER USER directory-service-username [ AS database-username ]
* `_directory-service-username_`
+
is the name that identifies the user in the directory service. This is also the name the user specifies when logging in to
-a Trafodion database. The _directory-service-username_ is a regular or delimited case-insensitive identifier.
+a {project-name} database. The _directory-service-username_ is a regular or delimited case-insensitive identifier.
See <<case_insensitive_delimited_identifiers,Case-Insensitive Delimited Identifiers>>.
* `_database-username_`
@@ -5745,13 +5745,13 @@ Database user names are limited to 128 characters.
* To register a user and assign a database username different than the user's login name:
+
```
-REGISTER USER "jsmith@hp.com" AS jsmith;
+REGISTER USER "jsmith@company.com" AS jsmith;
```
* To register a user without specifying a database username, so the database username will be the same as the user's login name:
+
```
-REGISTER USER "jsmith@hp.com";
+REGISTER USER "jsmith@company.com";
```
<<<
@@ -5760,8 +5760,8 @@ REGISTER USER "jsmith@hp.com";
The REVOKE statement revokes access privileges on an SQL object from specified users or roles.
-IMPORTANT: This statement works only when authentication and authorization are enabled in Trafodion. For more information,
-see http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure Trafodion].
+IMPORTANT: This statement works only when authentication and authorization are enabled in {project-name}. For more information,
+see http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure {project-name}].
```
REVOKE [GRANT OPTION FOR]
@@ -5944,10 +5944,10 @@ REVOKE GRANT OPTION FOR SELECT ON TABLE invent.partloc FROM clerks;
The REVOKE COMPONENT PRIVILEGE statement removes one or more component
privileges from a user or role. See <<privileges,Privileges>> and <<roles,Roles>>.
-REVOKE COMPONENT PRIVILEGE is a Trafodion SQL extension.
+REVOKE COMPONENT PRIVILEGE is a {project-name} SQL extension.
-IMPORTANT: This statement works only when authentication and authorization are enabled in Trafodion. For more information,
-see http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure Trafodion].
+IMPORTANT: This statement works only when authentication and authorization are enabled in {project-name}. For more information,
+see http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure {project-name}].
```
REVOKE [GRANT OPTION FOR]
@@ -6038,8 +6038,8 @@ REVOKE COMPONENT PRIVILEGE CREATE_TABLE ON SQL_OPERATIONS FROM sqluser1;
The REVOKE ROLE statement removes one or more roles from a user. See
<<roles,Roles>>.
-IMPORTANT: This statement works only when authentication and authorization are enabled in Trafodion. For more information,
-see http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure Trafodion].
+IMPORTANT: This statement works only when authentication and authorization are enabled in {project-name}. For more information,
+see http://trafodion.apache.org/enable-secure-trafodion.html[Enable Secure {project-name}].
```
REVOKE ROLE {role-name [,role-name]...}
@@ -6356,7 +6356,7 @@ you can associate a derived column, _col-expr_, with a _name_. _name_ is an SQL
* `FROM _table-ref_ [,_table-ref_]…`
+
specifies a list of tables, views, derived tables, or joined tables that determine the contents of an intermediate result
-table from which Trafodion SQL returns the columns you specify in _select-list_.
+table from which {project-name} SQL returns the columns you specify in _select-list_.
+
If you specify only one _table-ref_, the intermediate result table consists of rows derived from that table reference. If you specify more
than one _table-ref_, the intermediate result table is the cross-product of result tables derived from the individual table
@@ -6481,7 +6481,7 @@ _table-ref_ [_join-type_] JOIN _table-ref join-spec_
*** `_join-type_ is: INNER | LEFT [OUTER] | RIGHT [OUTER] | FULL [OUTER]`
+
is a joined table. You specify the _join-type_ by using the CROSS, INNER, OUTER, LEFT, RIGHT, and FULL keywords.
-If you omit the optional OUTER keyword and use LEFT, RIGHT, or FULL in a join, Trafodion SQL assumes the join is
+If you omit the optional OUTER keyword and use LEFT, RIGHT, or FULL in a join, {project-name} SQL assumes the join is
an outer join.
+
If you specify a CROSS join as the _join-type_, you cannot specify a NATURAL join or a
@@ -6558,7 +6558,7 @@ value constructors, each of which is enclosed in parentheses. A _row-value-const
or a row subquery (a subquery that returns a single row of column values). An operand of an expression cannot reference
a column (except when the operand is a scalar subquery returning a single column value in its result table).
+
-The use of NULL as a _row-value-const_ element is a Trafodion SQL extension.
+The use of NULL as a _row-value-const_ element is a {project-name} SQL extension.
+
A _simple-table_ can be specified by using the TABLE keyword followed by a table name, which is equivalent to the
query specification SELECT * FROM _table_.
@@ -6577,7 +6577,7 @@ or, in the case of multiple table references, the cross-product of result tables
Each column you specify in _search-condition_ is typically a column in this intermediate result table. In the case of nested
subqueries used to provide comparison values, the column can also be an outer reference. See<<subquery,Subquery>>.
+
-To comply with ANSI standards, Trafodion SQL does not move aggregate predicates from the WHERE clause to a HAVING clause and
+To comply with ANSI standards, {project-name} SQL does not move aggregate predicates from the WHERE clause to a HAVING clause and
does not move non-aggregate predicates from the HAVING clause to the WHERE clause.
* `SAMPLE _sampling-method_`
@@ -6587,20 +6587,20 @@ methods uses a sampling size. The three sampling methods\u2014random, first, and pe
** `RANDOM _percent-size_`
+
-directs Trafodion SQL to choose rows randomly (each row having an unbiased probability of being chosen) without replacement
+directs {project-name} SQL to choose rows randomly (each row having an unbiased probability of being chosen) without replacement
from the result table. The sampling size is determined by using a percent of the result table.
** `FIRST _rows-size_ [SORT BY _colname_ [,_colname_]…]`
+
-directs Trafodion SQL to choose the first _rows-size_ rows from the sorted result table. The sampling size is determined
+directs {project-name} SQL to choose the first _rows-size_ rows from the sorted result table. The sampling size is determined
by using the specified number of rows.
** `PERIODIC _rows-size_ EVERY _number-rows_ ROWS [SORT BY _colname_ [,_colname_] …]`
+
-directs Trafodion SQL to choose the first rows from each block (period) of contiguous sorted rows. The sampling size is
+directs {project-name} SQL to choose the first rows from each block (period) of contiguous sorted rows. The sampling size is
determined by using the specified number of rows chosen from each block.
-** SAMPLE is a Trafodion SQL extension. See <<sample_clause,SAMPLE Clause>>.
+** SAMPLE is a {project-name} SQL extension. See <<sample_clause,SAMPLE Clause>>.
* `TRANSPOSE _transpose-set_[_transpose-set_]… [KEY BY _key-colname_]`
+
@@ -6622,12 +6622,12 @@ optionally specifies an optional key column _key-colname_. It identifies which e
list corresponds to by its position in the _transpose-item-list_. _key-colname_ is an SQL identifier. The data type is exact
numeric, and the value is NOT NULL.
-** TRANSPOSE is a Trafodion SQL extension. See <<transpose_clause,TRANSPOSE Clause>>.
+** TRANSPOSE is a {project-name} SQL extension. See <<transpose_clause,TRANSPOSE Clause>>.
* `SEQUENCE BY _colname_ [ASC[ENDING] | DESC[ENDING]] [,_colname_ [ASC[ENDING] | DESC[ENDING]]] …`
+
specifies the order in which to sort the rows of the intermediate result table for calculating sequence functions. You must
-include a SEQUENCE BY clause if you include a sequence function in _select-list_. Otherwise, Trafodion SQL returns an error.
+include a SEQUENCE BY clause if you include a sequence function in _select-list_. Otherwise, {project-name} SQL returns an error.
Further, you cannot include a SEQUENCE BY clause if no sequence function is in _select-list_.
** `_colname_`
@@ -6637,7 +6637,7 @@ optionally qualified by a table, view, or correlation name; for example, CUSTOME
** `ASC | DESC`
+
-specifies the sort order. The default is ASC. When Trafodion SQL orders an intermediate result table on a column that can
+specifies the sort order. The default is ASC. When {project-name} SQL orders an intermediate result table on a column that can
contain null, nulls are considered equal to one another but greater than all other non-null values.
<<<
@@ -6667,7 +6667,7 @@ one null group. See <<considerations_for_group_by,Considerations for GROUP BY>>.
specifies a _search-condition_ to apply to each group of the grouped table resulting from the preceding GROUP BY clause
in the SELECT statement.
+
-To comply with ANSI standards, Trafodion SQL does not move aggregate predicates from the WHERE clause to a HAVING clause
+To comply with ANSI standards, {project-name} SQL does not move aggregate predicates from the WHERE clause to a HAVING clause
and does not move non-aggregate predicates from the HAVING clause to the WHERE clause.
+
If no GROUP BY clause exists, the _search-condition_ is applied to the entire table (which consists of one group) resulting
@@ -7353,14 +7353,14 @@ autocommit-option is:
* `_autocommit-option_`
+
-specifies whether Trafodion SQL commits or rolls back automatically at the end of statement execution. This option
+specifies whether {project-name} SQL commits or rolls back automatically at the end of statement execution. This option
applies to any statement for which the system initiates a transaction.
+
-If this option is set to ON, Trafodion SQL automatically commits any changes or rolls back any changes made to the
+If this option is set to ON, {project-name} SQL automatically commits any changes or rolls back any changes made to the
database at the end of statement execution. AUTOCOMMIT is on by default at the start of a session.
+
If this option is set to OFF, the current transaction remains active until the end of the session unless you explicitly
-commit or rollback the transaction. AUTOCOMMIT is a Trafodion SQL extension; you cannot use in it with any other option.
+commit or rollback the transaction. AUTOCOMMIT is a {project-name} SQL extension; you cannot use in it with any other option.
+
Using the AUTOCOMMIT option in a SET TRANSACTION statement does not reset other transaction attributes that may have
been specified in a previous SET TRANSACTION statement. Similarly, a SET TRANSACTION statement that does not specify
@@ -7391,8 +7391,8 @@ until you explicitly issue COMMIT or ROLLBACK.
=== Examples of SET TRANSACTION
* The following SET TRANSACTION statement turns off autocommit so that the current transaction remains active until the
-end of the session unless you explicitly commit or rollback the transaction. Trafodion SQL does not automatically commit
-or roll back any changes made to the database at the end of statement execution. Instead, Trafodion SQL commits all the
+end of the session unless you explicitly commit or rollback the transaction. {project-name} SQL does not automatically commit
+or roll back any changes made to the database at the end of statement execution. Instead, {project-name} SQL commits all the
changes when you issue the COMMIT WORK statement.
+
```
@@ -7424,7 +7424,7 @@ COMMIT WORK;
The SHOWCONTROL statement displays the default attributes in effect.
-SHOWCONTROL is a Trafodion SQL extension.
+SHOWCONTROL is a {project-name} SQL extension.
```
SHOWCONTROL {ALL | [QUERY] DEFAULT [attribute-name[, MATCH {FULL | PARTIAL }]]}
@@ -7435,7 +7435,7 @@ SHOWCONTROL {ALL | [QUERY] DEFAULT [attribute-name[, MATCH {FULL | PARTIAL }]]}
* `ALL`
+
-displays all the hard-coded default attributes that have been set for the Trafodion instance.
+displays all the hard-coded default attributes that have been set for the {project-name} instance.
* `[QUERY] DEFAULT`
+
@@ -7446,7 +7446,7 @@ see the <<control_query default_statement,Control Query Default Statement>>.
+
displays only the defaults that match, either fully or partially, the _attribute_ used in CONTROL QUERY DEFAULT
statements. The match is not case-sensitive. For descriptions of these attributes, see the
-http://trafodion.incubator.apache.org/docs/cqd_reference/index.html[Trafodion Control Query Default (CQD) Reference Guide].
+{docs-url}/cqd_reference/index.html[{project-name} Control Query Default (CQD) Reference Guide].
+
MATCH FULL specifies that _attribute-name_ must be the same as the attribute name used in a control query default
statement. match partial specifies that _attribute-name_ must be included in the attribute name used in a control
@@ -7485,7 +7485,7 @@ CONTROL QUERY DEFAULT
The SHOWDDL statement describes the DDL syntax used to create an object as it exists in the metadata, or it returns
a description of a user, role, or component in the form of a GRANT statement.
-SHOWDDL is a Trafodion SQL extension.
+SHOWDDL is a {project-name} SQL extension.
```
SHOWDDL showddl-spec
@@ -7621,7 +7621,7 @@ SHOWDDL Statement 161
The SHOWDDL SCHEMA statement displays the DDL syntax used to create a schema as it exists in the metadata and shows
the authorization ID that owns the schema.
-SHOWDDL SCHEMA is a Trafodion SQL extension.
+SHOWDDL SCHEMA is a {project-name} SQL extension.
```
SHOWDDL SCHEMA [catalog-name.]schema-name
@@ -7673,7 +7673,7 @@ The SHOWSTATS statement displays the histogram statistics for one or
more groups of columns within a table. These statistics are used to
devise optimized access plans.
-SHOWSTATS is a Trafodion SQL extension.
+SHOWSTATS is a {project-name} SQL extension.
```
SHOWSTATS FOR TABLE table-name ON group-list [DETAIL]
@@ -7911,7 +7911,7 @@ Job/Code Job Description
The UNREGISTER USER statement removes a database username from the SQL
database. The user can no longer log on to the database.
-UNREGISTER USER is a Trafodion SQL extension.
+UNREGISTER USER is a {project-name} SQL extension.
```
UNREGISTER USER database-username [RESTRICT | CASCADE]
@@ -7948,7 +7948,7 @@ DB ROOT is the only database user who has been granted the MANAGE_USERS
component privilege.
* You cannot unregister any username beginning with DB . Role names
-beginning with DB are reserved by Trafodion.
+beginning with DB are reserved by {project-name}.
* UNREGISTER USER fails if you specify RESTRICT (or nothing) and if the
user owns any objects or schemas or if the user has been granted any
privileges or roles.
@@ -7959,7 +7959,7 @@ privileges or roles.
* To unregister a user:
+
```
-UNREGISTER USER "jsmith@hp.com";
+UNREGISTER USER "jsmith@company.com";
```
<<<
@@ -8023,7 +8023,7 @@ _expression_ cannot contain an aggregate function defined on a column.
The data type of _expression_ must be compatible with the data type of
_column-name_.
+
-If _expression_ refers to columns being updated, Trafodion SQL uses the
+If _expression_ refers to columns being updated, {project-name} SQL uses the
original values to evaluate the expression and determine the new value.
See <<expressions,Expressions>>.
@@ -8118,7 +8118,7 @@ encountered or an error occurs.
[[update_isolation_levels_of_transactions_and_access_options_of_statements]]
==== Isolation Levels of Transactions and Access Options of Statements
-The isolation level of a Trafodion SQL transaction defines the degree to
+The isolation level of a {project-name} SQL transaction defines the degree to
which the operations on data within that transaction are affected by
operations of concurrent transactions. When you specify
access options for the DML statements within a transaction, you override
@@ -8150,11 +8150,11 @@ CREATE VIEW statement.
[[update_reporting_of_updates]]
==== Reporting of Updates
-When an UPDATE completes successfully, Trafodion SQL reports the number
+When an UPDATE completes successfully, {project-name} SQL reports the number
of times rows were updated during the operation.
Under certain conditions, updating a table with indexes can cause
-Trafodion SQL to update the same row more than once, causing the number
+{project-name} SQL to update the same row more than once, causing the number
of reported updates to be higher than the actual number of changed rows.
However, both the data in the table and the number of reported updates
are correct. This behavior occurs when all of these conditions are true:
@@ -8166,7 +8166,7 @@ that column is stored in ascending order), or a lower value (if that
column is stored in descending order).
When these conditions occur, the order of the index entries ensures that
-Trafodion SQL will encounter the same row (satisfying the same
+{project-name} SQL will encounter the same row (satisfying the same
_search-condition)_ at a later time during the processing of the table.
The row is then updated again by using the same value or values.
@@ -8178,7 +8178,7 @@ UPDATE MYTABLE SET B = 20 WHERE A > 10;
```
If the contents of columns A and B are 1 and 12 respectively before the
-UPDATE, after the UPDATE Trafodion SQL will encounter the same row
+UPDATE, after the UPDATE {project-name} SQL will encounter the same row
indexed by the values 1 and 20.
[[update_updating_character_values]]
@@ -8282,7 +8282,7 @@ UPDATE table3 SET b = b + 2000 WHERE a, b =
The UPSERT statement either updates a table if the row exists or inserts
into a table if the row does not exist.
-UPSERT is a Trafodion SQL extension.
+UPSERT is a {project-name} SQL extension.
```
UPSERT [USING LOAD] INTO table [(target-col-list)] {query-expr | values-clause}
@@ -8430,7 +8430,7 @@ statement. See the <<select statement,SELECT Statement>>.
==== Relationship to INSERT Statement
For a VALUES clause that is the direct source of an INSERT statement,
-Trafodion SQL also allows the keyword DEFAULT in a VALUES clause, just
+{project-name} SQL also allows the keyword DEFAULT in a VALUES clause, just
like NULL is allowed. For more information, see the
<<insert statement,INSERT Statement>>.
[16/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/about.adoc b/docs/cqd_reference/src/asciidoc/_chapters/about.adoc
index 732a6ce..51dac34 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/about.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/about.adoc
@@ -20,18 +20,18 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
-This guide describes Trafodion Control Query Defaults (CQDs) that are used to override
+This guide describes {project-name} Control Query Defaults (CQDs) that are used to override
system-level default settings.
== Intended Audience
This guide is intended for database administrators and application programmers who want to
-use CQDs to override system-default settings when querying a Trafodion database.
+use CQDs to override system-default settings when querying a {project-name} database.
== New and Changed Information
@@ -161,19 +161,8 @@ match-value [NOT] LIKE _pattern
[ESCAPE esc-char-expression]
```
-== Publishing History
-[cols="2*",options="header"]
-|===
-| Product Version | Publication Date
-| Trafodion Release 1.3.0 | January 2016.
-|===
-
== 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:
-
-issues@trafodion.incubator.apache.org
+We encourage 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 {project-support}.
-Include the document title and any comment, error found, or suggestion for improvement you have concerning this document. Or, even
-better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
+Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/debugging.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/debugging.adoc b/docs/cqd_reference/src/asciidoc/_chapters/debugging.adoc
index 3d50322..76bf6e9 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/debugging.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/debugging.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[debugging]]
@@ -40,12 +40,12 @@ This section describes CQDs that are used for debugging controls.
Default: *'0'*.
| *Usage* |
See See https://cwiki.apache.org/confluence/display/TRAFODION/Tutorial%3A+The+object-oriented+UDF+interface#Tutorial:Theobject-orientedUDFinterface-DebuggingUDFcode[UDF Tutorial].
-| *Production Usage* | Consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Not applicable.
| *Level* | Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -62,12 +62,12 @@ See See https://cwiki.apache.org/confluence/display/TRAFODION/Tutorial%3A+The+ob
Default: *'0'*.
| *Usage* |
See See https://cwiki.apache.org/confluence/display/TRAFODION/Tutorial%3A+The+object-oriented+UDF+interface#Tutorial:Theobject-orientedUDFinterface-DebuggingUDFcode[UDF Tutorial].
-| *Production Usage* | Consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Not applicable.
| *Level* | Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -84,12 +84,12 @@ See See https://cwiki.apache.org/confluence/display/TRAFODION/Tutorial%3A+The+ob
Default: *'0'*.
| *Usage* |
See See https://cwiki.apache.org/confluence/display/TRAFODION/Tutorial%3A+The+object-oriented+UDF+interface#Tutorial:Theobject-orientedUDFinterface-DebuggingUDFcode[UDF Tutorial].
-| *Production Usage* | Consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Not applicable.
| *Level* | Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/histograms.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/histograms.adoc b/docs/cqd_reference/src/asciidoc/_chapters/histograms.adoc
index 7086d90..4e1535b 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/histograms.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/histograms.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[manage-histograms]]
@@ -55,7 +55,7 @@ the histograms. More obsolete histograms may result in poor performance for quer
| *Level* | System or Service.
| *Conflicts/Synergies* | Frequency of update statistics run using MAINTAIN.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -100,7 +100,7 @@ may not bring commensurate benefit to a large number of queries.
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -128,7 +128,7 @@ then the compiler may be working with obsolete histogram statistics, potentially
| *Level* | Service.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -150,7 +150,7 @@ The default value is *'ON'*.
| *Level* | System or Service.
| *Conflicts/Synergies* | Use this CQD with <<cache-histograms,CACHE_HISTOGRAMS>>. If CACHE_HISTOGRAMS is OFF, then this CQD has no effect.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -160,7 +160,7 @@ The default value is *'ON'*.
[cols="25%h,75%"]
|===
-| *Description* | Specifies the minimum row count for which the Trafodion Optimizer needs histograms, in order to compute better cardinality estimates.
+| *Description* | Specifies the minimum row count for which the {project-name} Optimizer needs histograms, in order to compute better cardinality estimates.
The Optimizer does not issue any missing statistics warnings for tables whose size is smaller than the value of this CQD.
| *Values* | Integer. +
+
@@ -173,7 +173,7 @@ However, there may be some exceptions where missing statistics on small tables c
| *Conflicts/Synergies* | Use this CQD with <<hist-missing-stats-warning-level,HIST_MISSING_STATS_WARNING_LEVEL>>. If the warning level CQD is 0,
then this CQD does not have any effect. Also, for tables having fewer rows than set in this CQD, no warnings are displayed irrespective of the warning level.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -202,6 +202,6 @@ However, it can also increase the compile time.
| *Level* | Any.
| *Conflicts/Synergies* | In order to use the feature in its default form, sample tables should exist in `public_access_schema`.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/introduction.adoc b/docs/cqd_reference/src/asciidoc/_chapters/introduction.adoc
index fe3be20..96c5917 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/introduction.adoc
@@ -20,14 +20,14 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[introduction]]
= Introduction
Refer to the
-http://trafodion.apache.org/docs/sql_reference/index.html#control_query_cancel_statement[Trafodion SQL Reference Manual]
+http://trafodion.apache.org/docs/sql_reference/index.html#control_query_cancel_statement[{project-name} SQL Reference Manual]
full documentation of the CQD (CONTROL QUERY DEFAULT) statement.
The CONTROL QUERY DEFAULT statement changes the default settings for the current process. You can execute
@@ -83,7 +83,7 @@ The following information is provided for each CQD:
+
• Values, in the form of a character string, that specify the applicable attribute values for the CQD. +
• The default attribute value. +
-• If applicable, the Trafodion release in which the attribute values or default changed.
+• If applicable, the {project-name} release in which the attribute values or default changed.
| *Usage* | Describes the conditions when the CQD is helpful, and how to detect the conditions.
| *Production Usage* | Identifies when the CQD is not safe to be used as a permanent setting in production.
| *Impact* | Describes any positive and negative implications of using the CQD.
@@ -97,6 +97,6 @@ The following information is provided for each CQD:
NOTE: This level indicates that the CQD can be used at the Query, Session or Service level as long as you fully understands the scope of the impact of the CQD.
| *Conflicts/Synergies* | Describes CQDs that are in conflict with or can be used in conjunction with the CQD.
| *Real Problem Addressed* | Describes any design or solution that the CQD may be a workaround for and how you can directly address the real problem.
-| *Introduced In Release* | Indicates the Trafodion release when the CQD was introduced.
+| *Introduced In Release* | Indicates the {project-name} release when the CQD was introduced.
| *Deprecated In Release* | Indicates in what release the CQD was deprecated.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/operational_controls.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/operational_controls.adoc b/docs/cqd_reference/src/asciidoc/_chapters/operational_controls.adoc
index 8d077cf..dd4ff8b 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/operational_controls.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/operational_controls.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[operational-controls]]
@@ -48,7 +48,7 @@ then a large number of queries may be impacted. Therefore, you need to assess if
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -73,7 +73,7 @@ Change this setting if you see explain plan being undesirably truncated only.
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -83,21 +83,21 @@ Change this setting if you see explain plan being undesirably truncated only.
[cols="25%h,75%"]
|===
-| *Description* | Enables Trafodion to use HBase block cache in an optimal manner. Defines the maximum Java
+| *Description* | Enables {project-name} to use HBase block cache in an optimal manner. Defines the maximum Java
heap size (-Xmx option) the HBase Region Server are assigned, in MB units.
| *Values* |
Positive integer. +
+
Default: *'1024'*.
| *Usage* | If the HBase Region servers are configured with a maximum Java heap size different than 1 GB, then
-set this attribute so that Trafodion is aware of the actual maximum heap size of the Region Servers.
+set this attribute so that {project-name} is aware of the actual maximum heap size of the Region Servers.
| *Production Usage* | Yes.
| *Impact* | When set correctly, this CQD ensures that HBase block cache are be used optimally. Small scans
are cached and larger scans are not cached to avoid cache trashing.
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -114,19 +114,19 @@ are cached and larger scans are not cached to avoid cache trashing.
*> 0*: The cached Hive meta-data is valid only for <value> seconds. +
+
Default: *'0'*.
-| *Usage* | Use a value of -1 when the Hive tables are read-only. This allows Trafodion to avoid repeatedly reading the
+| *Usage* | Use a value of -1 when the Hive tables are read-only. This allows {project-name} to avoid repeatedly reading the
metadata when the table is referenced in multiple queries. +
+
Use a value of 0 when updates to the Hive tables are likely to be frequent. +
+
-Use a positive value _n_ to cause Trafodion to re-read metadata after n seconds has elapsed.
+Use a positive value _n_ to cause {project-name} to re-read metadata after n seconds has elapsed.
Use this option when updates to the Hive table happen at least _n_ seconds apart.
-| *Production Usage* | Consult with the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Compilation time.
| *Level* | Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -182,7 +182,7 @@ including case and white space. By caching text-based queries, the compiler avoi
queries and improves performance by reducing compile times and increasing compiler throughput. The text cache is always searched first for a query.
If the plan object is not produced due to a text cache miss, then the plan is stored in the template cache if it meets the criteria for template caching.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -207,7 +207,7 @@ Change the default to ON only when certain that new rows do not have a conflict
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -230,7 +230,7 @@ Consider using lower values if the table has several indexes and is memory const
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/query_execution.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/query_execution.adoc b/docs/cqd_reference/src/asciidoc/_chapters/query_execution.adoc
index eae1ff3..91d390a 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/query_execution.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/query_execution.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[query-execution]]
@@ -47,7 +47,7 @@ in different threads.
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -66,12 +66,12 @@ The default value is *'SYSTEM'*.
In LRU block cache configuration, the amount of block cache retained in memory is proportional to the amount of reserved maximum
Java heap size of the region server. LRU Block Cache is the default in HBase. +
+
-The Trafodion Optimizer determines whether a sequential scan of the HBase table in a query would cause the full eviction of the
+The {project-name} Optimizer determines whether a sequential scan of the HBase table in a query would cause the full eviction of the
data blocks cached earlier thereby impacting the performance of the random reads. The cache blocks option is turned off for the table
in such a case. +
+
Set the CQD <<hbase-region-server-max-heap-size,HBASE_REGION_SERVER_MAX_HEAP_SIZE>> value to reflect the amount of java heap size reserved for the region servers.
-This CQD is used by the Trafodion Optimizer to evaluate if the block cache should be turned off.
+This CQD is used by the {project-name} Optimizer to evaluate if the block cache should be turned off.
| *Production Usage* | Leave the setting to be 'SYSTEM' when HBase is configured to use LRU block cache. If needed,
you can override this settings with 'ON' or 'OFF'. +
+
@@ -80,7 +80,7 @@ With other HBase configurations, you need to set HBASE_CACHE_BLOCKS to 'ON' or '
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -104,12 +104,12 @@ An explain plan can show whether predicates are successfully pushed down to the
The default value is *'OFF'*.
| *Usage* | Used to improve performance by reducing the number of columns retrieved to a strict minimum
and filter out rows as early as possible.
-| *Production Usage* | Please consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Using this CQD increases the amount of work done in the HBase Region Servers.
| *Level* | System or Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 2.0.0.
+| *Introduced In Release* | {project-name} 2.0.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -119,10 +119,10 @@ and filter out rows as early as possible.
[cols="25%h,75%"]
|===
-| *Description* | Treat salted Trafodion tables as hash-partitioned on the salt columns.
+| *Description* | Treat salted {project-name} tables as hash-partitioned on the salt columns.
| *Values* |
-*'OFF'*: Salted Trafodion tables are not hash-partitioned on the salt columns. +
-*'ON'*: Salted Trafodion tables are hash-partitioned on the salt columns. +
+*'OFF'*: Salted {project-name} tables are not hash-partitioned on the salt columns. +
+*'ON'*: Salted {project-name} tables are hash-partitioned on the salt columns. +
+
The default value is *'ON'*.
| *Usage* | If, for any reason, there are issues with parallel plans on salted tables (especially with data skew) then try setting this CQD to OFF.
@@ -131,7 +131,7 @@ The default value is *'ON'*.
| *Level* | System or Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 2.0.0.
+| *Introduced In Release* | {project-name} 2.0.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -151,13 +151,13 @@ a sequential scan of a table. +
+
You need to consider how soon the maximum number of rows are materialized on the Region Servers. When filtering is pushed down to Region Servers,
then it can take a longer time depending upon the query and the predicates involved. This can result in HBase scanner timeouts.
-| *Production Usage* | Use the default setting and reduce the value to avoid HBase scanner timeouts. Consult with the Trafodion community
+| *Production Usage* | Use the default setting and reduce the value to avoid HBase scanner timeouts. Please contact {project-support}.
if you think that you need to use this CQD.
| *Impact* | Not applicable.
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -173,16 +173,16 @@ if you think that you need to use this CQD.
*'OFF'*: Do not perform IUD operations as an HBase batch `put` operation. +
+
The default value is *'ON'*.
-| *Usage* | When IUD operation involves multiple tuples, then the Trafodion Optimizer evaluates whether these operations
+| *Usage* | When IUD operation involves multiple tuples, then the {project-name} Optimizer evaluates whether these operations
can be done in a batch manner at the HBase level thereby reducing the network interactions between the client applications and the HBase Region Servers. +
+
-If possible, then the query plan involves VSBB operators. The Virtual Sequential Block Buffer(VSBB) name is retained in Trafodion though it is unrelated to HBase.
+If possible, then the query plan involves VSBB operators. The Virtual Sequential Block Buffer(VSBB) name is retained in {project-name} though it is unrelated to HBase.
| *Production Usage* | Yes.
| *Impact* | IUD operations can become slower if this CQD is set to 'OFF'.
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -197,8 +197,8 @@ If possible, then the query plan involves VSBB operators. The Virtual Sequential
Numeric value.
+
The default value is *'1024'*.
-| *Usage* | The Trafodion execution engine already adjusts the number of rows in a batch depending upon how fast
-the queue to IUD (INSERT,UPDATE,DELETE) operator is filled up in the data flow architecture of Trafodion. +
+| *Usage* | The {project-name} execution engine already adjusts the number of rows in a batch depending upon how fast
+the queue to IUD (INSERT,UPDATE,DELETE) operator is filled up in the data flow architecture of {project-name}. +
+
You can adjust the maximum size to suit your application needs and thus tune it to perform optimally.
| *Production Usage* | Yes. You can disable this feature by setting the HBASE_ROWSET_VSBB_OPT CQD to 'OFF'.
@@ -206,7 +206,7 @@ You can adjust the maximum size to suit your application needs and thus tune it
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -216,24 +216,24 @@ You can adjust the maximum size to suit your application needs and thus tune it
[cols="25%h,75%"]
|===
-| *Description* | Enables Trafodion to leverage the HBase small scanner optimization. This optimization reduces I/O usage up to 66%
+| *Description* | Enables {project-name} to leverage the HBase small scanner optimization. This optimization reduces I/O usage up to 66%
and enables non-blocking reads for higher concurrency support. When a scan is known to require less than a HBASE BLOCK SIZE (default is 64K),
then enabling the HBase small scanner optimization increases performance.
| *Values* |
*'OFF'*: Never use the HBase small scanner optimization. +
-*'SYSTEM'*: Only enable the HBase small scanner optimization when the Trafodion Compiler determines that the scan size will fit in the table's HBASE BLOCK SIZE +
+*'SYSTEM'*: Only enable the HBase small scanner optimization when the {project-name} Compiler determines that the scan size will fit in the table's HBASE BLOCK SIZE +
*'ON'*: Enable the HBase small scanner optimization regardless of the size of scan. +
+
The default value is *'OFF'*.
| *Usage* | Consider using this CQD to improve the performance of your queries.
-| *Production Usage* | Consult with the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | The performance of small scan may increase by 1.4x. This CQD can be very useful for MDAM scans.
| *Level* | System or Session.
| *Conflicts/Synergies* | MDAM performance may be improved by 1.4x when correctly picking HBase block size so that each MDAM scan operation fit within a HBASE BLOCK SIZE boundary. +
+
If you enable small scanner on large size scan incorrectly, then you are likely to see a 6% performance decrease. The returned results will still be correct.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 2.0.0.
+| *Introduced In Release* | {project-name} 2.0.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/query_plans.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/query_plans.adoc b/docs/cqd_reference/src/asciidoc/_chapters/query_plans.adoc
index c72aa46..2791e96 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/query_plans.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/query_plans.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[query-plans]]
@@ -56,7 +56,7 @@ elapsed time for some of the longer running queries that leverage adaptive segme
parallelism only for a certain set of queries and use it at the service level.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -66,7 +66,7 @@ parallelism only for a certain set of queries and use it at the service level.
[cols="25%h,75%"]
|===
-| *Description* | Determines whether the Trafodion Optimizer considers Hash Join when generating an execution plan.
+| *Description* | Determines whether the {project-name} Optimizer considers Hash Join when generating an execution plan.
| *Values* |
*'ON'* Hash Join is considered. +
*'OFF'* Hash Join is not considered. +
@@ -79,7 +79,7 @@ It is highly recommended that you do not turn HASH_JOINS OFF; that is, this CQD
| *Level* | Query.
| *Conflicts/Synergies* | If you turn all three join implementations OFF (Hash Joins, Nested Joins, and Merge Joins), then the compiler may fail to generate query plans.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -95,17 +95,17 @@ It is highly recommended that you do not turn HASH_JOINS OFF; that is, this CQD
*'OFF'*: Do not use HBase coprocessors. +
+
The default value is *'ON'*.
-| *Usage* | Enables Trafodion to use HBase coprocessors to do early aggregation and filtering
-at the HBase Region Server level. This CQD does not affect Transaction coprocessors used by Trafodion. +
+| *Usage* | Enables {project-name} to use HBase coprocessors to do early aggregation and filtering
+at the HBase Region Server level. This CQD does not affect Transaction coprocessors used by {project-name}. +
+
As of Release 2.0 only COUNT(*) queries will be affected by this attribute.
| *Production Usage* | Yes.
-| *Impact* | Network traffic between Region Server and Trafodion processes is reduced but
+| *Impact* | Network traffic between Region Server and {project-name} processes is reduced but
the Region Server can become very busy when aggregating over large tables.
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -129,7 +129,7 @@ On the other hand decreasing the attribute to 1 could help with concurrency.
| *Conflicts/Synergies* | The CQD <<hive-min-bytes-per-esp-partition,HIVE_MIN_BYTES_PER_ESP_PARTITION>> (default = 67108864) may need to be adjusted downward
when this attribute is used to increase the parallelism of scanning smaller Hive tables.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -155,7 +155,7 @@ specified in the FROM clause, the plan generated may not be the optimal one.
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -183,12 +183,12 @@ A value of *0* treats every multi-column value as skew values. This may increase
side child of the hash join to all join processes. +
+
A value *greater than 0* selects those multi-column values as skewed values if their occurrence frequencies are high enough.
-| *Production Usage* | Consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | This CQD impacts runtime performance.
| *Level* | Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -199,7 +199,7 @@ A value *greater than 0* selects those multi-column values as skewed values if t
[cols="25%h,75%"]
|===
| *Description* | This CQD effects the behavior of the query optimizer when there are no statistics available for a query
-having range predicates on key columns. The Trafodion Optimizer calculates the worst case number of seeks that the MDAM access method
+having range predicates on key columns. The {project-name} Optimizer calculates the worst case number of seeks that the MDAM access method
would do if chosen for the query. +
+
If this number is greater than the value of MDAM_NO_STATS_POSITIONS_THRESHOLD, then MDAM is not considered for the query execution plan.
@@ -210,13 +210,13 @@ Default value: *10*.
| *Usage* | In certain situations, queries on tables lacking statistics may not be optimal because MDAM was not chosen.
Increasing the value for this CQD allows MDAM to be chosen in more cases. On the other hand, if the value is made too high and the worst case
scenario actually occurs, an MDAM plan may perform poorly.
-| *Production Usage* | Consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Table scans on tables lacking statistics may improve by varying the value of this CQD.
Results vary depending on the actual data in the table and the semantics of the query.
| *Level* | Query.
| *Conflicts/Synergies* | If <<mdam-scan-method,MDAM_SCAN_METHOD>> is set to *'OFF'*, then this CQD has no effect.
| *Real Problem Addressed* | Perform UPDATE STATISTICS on the table (at the very least on key columns) to obtain statistics.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -233,7 +233,7 @@ Results vary depending on the actual data in the table and the semantics of the
*'OFF'* MDAM is disabled. +
+
The default value is *'ON'*.
-| *Usage* | In certain situations, the Trafodion Optimizer might choose MDAM inappropriately, causing poor performance.
+| *Usage* | In certain situations, the {project-name} Optimizer might choose MDAM inappropriately, causing poor performance.
In such situations you may want to turn MDAM OFF for the query it is effecting.
| *Production Usage* | Yes.
| *Impact* | Table scans with predicates on non-leading clustering key column(s) could benefit from MDAM access
@@ -243,7 +243,7 @@ there may be cases (usually a defect) where a larger set of queries is being neg
to set it at the service or system level.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -272,9 +272,9 @@ time because the optimizer now has to consider many more join options.
there may be cases (usually a defect) where a larger set of queries is being negatively impacted by Merge Joins. In those cases you may want to
set it at the service or system level.
| *Conflicts/Synergies* | Avoid turning all the three join implementations OFF (Hash Joins, Nested Joins, and Merge Joins).
-This may result in the Trafodion Compiler failing to generate query plans.
+This may result in the {project-name} Compiler failing to generate query plans.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -302,7 +302,7 @@ such as light workloads and star join queries.
This may result in the compiler failing to generate query plans.
| *Real Problem Addressed* | The problem of inefficient Nested Joins can be better handled using a higher degree of query plan
robustness as set by the <<robust-query-optimization,ROBUST_QUERY_OPTIMIZATION>> CQD.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -327,7 +327,7 @@ Increasing the optimization level over the system default may result in very hig
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -352,7 +352,7 @@ query workloads, but has the potential disadvantage of increasing the elapsed ti
| *Level* | Service.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -378,7 +378,7 @@ may be used to influence the optimizer to consider another join instead, such as
+
NESTED_JOINS OFF could turn nested joins off completely. However, there are many cases where nested joins do provide better performance than hash
joins, and turning them off completely may negatively impact the performance of queries that can do a lot better with nested joins.
-| *Production Usage* | Consult with the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Specifying a risk premium insures against nested joins being chosen when they should not have been. However,
this can also result in nested joins not being chosen where the cardinality estimation was in fact accurate and a nested join could have
performed better. Therefore, this setting should be used with care in order to get robustness with a net gain in performance.
@@ -388,7 +388,7 @@ than other workloads. In such cases this could be used at the Service level.
influencing the nested join risk premium as well. It is advisable that you use that setting instead to influence plans, unless they are specifically
addressing nested join issues and need to use this setting independent of that CQD.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -411,7 +411,7 @@ allowed to win over competing parallel plans. +
+
If it is determined that the optimizer is using serial plans often enough where these plans are resulting in poor performance, then this CQD
may be used to influence the optimizer to consider parallel plans instead in some of those cases. +
-| *Production Usage* | Consult with the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Specifying a risk premium insures against serial plans being chosen when they should not have been.
However, this can also result in serial plans not being chosen where the cardinality estimation was in fact accurate and a serial plan
could have performed better. Therefore, this setting should be used with care in order to get robustness with a net gain in performance.
@@ -421,7 +421,7 @@ CQD more than other workloads. In such cases this could be used at the Service l
influencing the serial plan risk premium as well. It is advised that you use that setting instead to influence plans, unless they are specifically
addressing serial plan issues and need to use this setting independent of that CQD.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -434,7 +434,7 @@ addressing serial plan issues and need to use this setting independent of that C
| *Description* | Defines the minimal estimated max cardinality or row count of any relational operators in a query above
which the risk premium for serial plan is applied. +
+
-A serial query plan is favored by the Trafodion Compiler when it estimates the query reads and processes small amount of data.
+A serial query plan is favored by the {project-name} Compiler when it estimates the query reads and processes small amount of data.
The estimation error could become large when some operator is calculated to produce many rows yielding a non-optimal serial plan.
This CQD helps prevent utilizing serial plan in such cases.
| *Values* | An unsigned integer value.
@@ -442,12 +442,12 @@ This CQD helps prevent utilizing serial plan in such cases.
+
Use of a value smaller than the default (10,000) to penalize more serial plans or favor more parallel plans for operators produce less number of rows.
Otherwise, use of a larger value.
-| *Production Usage* | Consult with the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | This CQD impacts plan quality.
| *Level* | Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -529,7 +529,7 @@ use the individual CQDs at a finer granularity, such as at a query level, to get
or serial plan being chosen when it shouldn't have been, may be due to not enough, or inaccurate, histogram statistics information available
to the optimizer. So, first and foremost, histogram statistics should be kept up to date along with the multi-column statistics that the
optimizer may warn about. However, cardinality underestimations may still happen at higher levels of an execution plan.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -551,7 +551,7 @@ The default value is *'OFF'*.
| *Level* | Any.
| *Conflicts/Synergies* | Allows additional information to be displayed in explain plans. It has no impact on query plans.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -590,7 +590,7 @@ information about the table skew, the query, and the value that worked. Filing a
| *Conflicts/Synergies* | SKEW_EXPLAIN can be used as described in above. Also, <<skew-sensitivity-threshold,SKEW_SENSITIVITY_THRESHOLD>>
is relevant if this threshold allows a skew to be detected only.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -623,7 +623,7 @@ as it effectively turns off skew buster.
The <<skew-rowcount-threshold,SKEW_ROWCOUNT_THRESHOLD CQD>> controls the row count of the table at which the optimizer looks for a skew.
| *Real Problem Addressed* | Skew is quite common in a real big-data application, and is effectively addressed by skew buster.
However, there may be design opportunities that could help address the problem as well.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -640,13 +640,13 @@ However, there may be design opportunities that could help address the problem a
+
The default value is *'ON'*.
| *Usage* | Turn this CQD OFF when (in rare cases) unnesting a correlated subquery causes performance to degrade.
-If this attribute has to be turned OFF, then that could indicate a bug in the Trafodion Optimizer. Consult with the Trafodion community.
+If this attribute has to be turned OFF, then that could indicate a bug in the {project-name} Optimizer. Please contact {project-support}.
| *Production Usage* | Yes.
| *Impact* | Turn OFF with caution at a system level, as other queries which rely on un-nesting could be adversely impacted.
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -664,12 +664,12 @@ network traffic between the ESP processes and the HBase Region Servers.
+
The default value is *'OFF'*.
| *Usage* | Enable the feature when each region server serves approximately equal amount of data, and/or reducing network traffic is important.
-| *Production Usage* | Consult with the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Plan quality.
| *Level* | Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -697,7 +697,7 @@ which improves the performance of the UPSERT statements with omitted default val
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -722,6 +722,6 @@ you could set this CQD to OFF.
| *Level* | Query.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/runtime_controls.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/runtime_controls.adoc b/docs/cqd_reference/src/asciidoc/_chapters/runtime_controls.adoc
index 4196115..2b727a6 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/runtime_controls.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/runtime_controls.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[runtime-controls]]
@@ -45,7 +45,7 @@ returning the rows to the client. It is especially useful for testing the plans
| *Conflicts/Synergies* | Not to be confused with SELECT [LAST 0] which behaves the same way but does not guarantee that the plan
is the same as when you do not use the [LAST 0] clause in the query.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -76,6 +76,6 @@ However, if the default is set too low, then even well behaved, useful queries f
| *Level* | Service.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Use standard processed for creating high-quality queries, and procedures that ensure that table histograms are always current.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/schema_controls.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/schema_controls.adoc b/docs/cqd_reference/src/asciidoc/_chapters/schema_controls.adoc
index 0f84bb0..9a64c0b 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/schema_controls.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/schema_controls.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[schema-controls]]
@@ -37,7 +37,7 @@ This section describes CQDs that are used for schema controls.
| *Values* | Any valid ANSI name, including delimited names. +
+
The default is *'TRAFODION'*.
-| *Usage* | Trafodion tables must be in a catalog called TRAFODION. If you mostly access Hive or native HBase tables,
+| *Usage* | {project-name} tables must be in a catalog called TRAFODION. If you mostly access Hive or native HBase tables,
then the catalog could be changed to HIVE or HBASE respectively. +
+
The default setting is overridden by any catalog name specified in a SQL statement.
@@ -46,7 +46,7 @@ The default setting is overridden by any catalog name specified in a SQL stateme
| *Level* | Any.
| *Conflicts/Synergies* | Alternately you can use the SET CATALOG statement.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -66,6 +66,6 @@ The default is *'TRAFODION'*.
| *Level* | Any.
| *Conflicts/Synergies* | Alternately you can use the SET SCHEMA statement.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/table_definition.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/table_definition.adoc b/docs/cqd_reference/src/asciidoc/_chapters/table_definition.adoc
index 0a93dce..169638c 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/table_definition.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/table_definition.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[table_definition]]
@@ -33,20 +33,20 @@ This section describes CQDs that are used for table definition
[cols="25%h,75%"]
|===
-| *Description* | Allow Trafodion tables to be created with NULLABLE columns in the PRIMARY or STORE BY key.
+| *Description* | Allow {project-name} tables to be created with NULLABLE columns in the PRIMARY or STORE BY key.
| *Values* | *'ON'* or *'OFF'* +
+
The default value is *'OFF'*.
-| *Usage* | Allows NULLABLE columns to be included in the PRIMARY or STORE BY key for Trafodion tables.
+| *Usage* | Allows NULLABLE columns to be included in the PRIMARY or STORE BY key for {project-name} tables.
This CQD must be set prior to creating the table. It is not necessary to specify this CQD during DML operations on the table. +
+
When performing UPDATE STATISTICS with SAMPLE option on such tables, this CQD must be set so that an appropriate sample table can be created.
-| *Production Usage* | Please consult with the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Two bytes are added to the key for each nullable column.
| *Level* | Session.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -56,11 +56,11 @@ When performing UPDATE STATISTICS with SAMPLE option on such tables, this CQD mu
[cols="25%h,75%"]
|===
-| *Description* | Allow Trafodion tables to be created with specified HBase block size.
+| *Description* | Allow {project-name} tables to be created with specified HBase block size.
| *Values* | Positive integer. +
+
The default value is *'65536'*.
-| *Usage* | The value of this attribute is passed on to HBase when a Trafodion table is created in HBase.
+| *Usage* | The value of this attribute is passed on to HBase when a {project-name} table is created in HBase.
See the https://hbase.apache.org/book.html[Apache HBase(TM) Reference Guide] for usage information .
| *Production Usage* | Yes.
| *Impact* | The impact depends on the type of table access. Choose a block size that is appropriate
@@ -68,7 +68,7 @@ for how the table is primarily accessed.
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -89,7 +89,7 @@ Default: *'UTF8'*
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -99,8 +99,8 @@ Default: *'UTF8'*
[cols="25%h,75%"]
|===
-| *Description* | For certain character sets that are not supported in Trafodion, you can specify the character set here
-causing Trafodion to automatically convert the data to the character set specified in the HIVE_DEFAULT_CHARSET CQD. +
+| *Description* | For certain character sets that are not supported in {project-name}, you can specify the character set here
+causing {project-name} to automatically convert the data to the character set specified in the HIVE_DEFAULT_CHARSET CQD. +
+
This feature is currently supported only for *'GBK'*, and only if HIVE_DEFAULT_CHARSET is set to *'UTF8'*.
| *Values* |
@@ -113,7 +113,7 @@ Default: empty
| *Level* | System.
| *Conflicts/Synergies* | Only applicable if HIVE_DEFAULT_CHARSET is set to *'UTF8'*.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -123,7 +123,7 @@ Default: empty
[cols="25%h,75%"]
|===
-| *Description* | Hive columns of type STRING have a maximum length in Trafodion, which you can specify with this CQD. +
+| *Description* | Hive columns of type STRING have a maximum length in {project-name}, which you can specify with this CQD. +
+
*NOTE* For UTF-8 data, this length is specified in bytes, not UTF-8 characters.
| *Values* |
@@ -136,7 +136,7 @@ Default: 32000.
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/transactions.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/transactions.adoc b/docs/cqd_reference/src/asciidoc/_chapters/transactions.adoc
index 6a18aab..e0046b9 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/transactions.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/transactions.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[transaction-control-and-locking]]
@@ -65,7 +65,7 @@ is provided. This default attribute specifies the isolation level for update and
SYSTEM_DEFAULTS table, the default value is the same as the ISOLATION_LEVEL default attribute. However, if specified or present in the SYSTEM_DEFAULTS table,
then its value is used as the isolation level for updates and DDL statements. UPDATE in ISOLATION_LEVEL_FOR_UPDATES refers to INSERT, UPDATE, and DELETE statements.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -87,6 +87,6 @@ The default value is *'READ COMMITTED'* (ANSI).
ISOLATION_LEVEL can be set to READ UNCOMMITTED. This CQD still remains READ COMMITTED. You can change it to READ UNCOMMITTED to prevent queries
running at the service level to not perform any updates.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/_chapters/update_stats.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/_chapters/update_stats.adoc b/docs/cqd_reference/src/asciidoc/_chapters/update_stats.adoc
index 9695e3f..b683897 100644
--- a/docs/cqd_reference/src/asciidoc/_chapters/update_stats.adoc
+++ b/docs/cqd_reference/src/asciidoc/_chapters/update_stats.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[update-statistics-and-reorg]]
@@ -47,7 +47,7 @@ However, if a table is not used frequently, then this CQD influences how frequen
+
A smaller setting reduces the number of histograms being updated if there are many tables that have not been used within that interval.
A larger setting updates histogram for many more tables that are not being accessed that often.
-| *Production Usage* | Consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Influences the number of histograms that need to be regenerated and therefore the time it takes for
update statistics automation to regenerate histograms for all the tables that so qualify.
| *Level* | System.
@@ -56,7 +56,7 @@ update statistics automation to regenerate histograms for all the tables that so
It is influenced by USTAT_AUTO_READTIME_UPDATE_INTERVAL, which influences how often READ_TIME is updated for the histogram.
This CQD qualifies the histogram to be regenerated; it is the maximum time since READ_TIME was updated. $$$
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -74,7 +74,7 @@ The default value is 10000.
| *Usage* | Influences for what tables sampling is used for histogram statistics generation. If the setting is smaller,
then more tables qualify for sampling. If the setting is larger, then fewer tables qualify for sampling. Sampling can result in faster update
statistics run times. But for smaller tables, it can also result in poor histogram accuracy which could result in poor query plans.
-| *Production Usage* | Consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Setting this CQD to a smaller value means that sampling is used for tables with fewer rows, when the SAMPLE option is
specified as part of update statistics. This can result in less accurate histograms and poor query plans, because the sample size may be too small to
generate good estimates for histograms. +
@@ -84,7 +84,7 @@ However, these tables may also have more accurate histograms.
| *Level* | System.
| *Conflicts/Synergies* | Not applicable.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
@@ -103,13 +103,13 @@ the <<hist-default-sample-min,HIST_DEFAULT_SAMPLE_MIN>> CQD. (which defaults to
The default for this CQD is *1,000,000*.
| *Usage* | Prevents accidental use of too-small samples when generating statistics on tables. If sample sizes are too small,
then histogram statistics will be less accurate, leading to potentially less efficient query plans.
-| *Production Usage* | Consult the Trafodion community.
+| *Production Usage* | Please contact {project-support}.
| *Impact* | Setting this CQD to lower values may result in smaller sample sizes for small tables.
This may slightly improve UPDATE STATISTICS run time, but at the cost of potentially less efficient queries.
| *Level* | System.
| *Conflicts/Synergies* | <<hist-default-sample-min,HIST_DEFAULT_SAMPLE_MIN>> effects the behavior of this CQD.
| *Real Problem Addressed* | Not applicable.
-| *Introduced In Release* | Trafodion 1.3.0.
+| *Introduced In Release* | {project-name} 1.3.0.
| *Deprecated In Release* | Not applicable.
|===
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/cqd_reference/src/asciidoc/index.adoc b/docs/cqd_reference/src/asciidoc/index.adoc
index 9de403c..690a991 100644
--- a/docs/cqd_reference/src/asciidoc/index.adoc
+++ b/docs/cqd_reference/src/asciidoc/index.adoc
@@ -32,7 +32,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
:images: ../images
:leveloffset: 1
@@ -41,22 +42,10 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-**License Statement**
+include::../../shared/license.txt[]
-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.
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/jdbct4ref_guide/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/asciidoc/index.adoc b/docs/jdbct4ref_guide/src/asciidoc/index.adoc
index 38e2f3e..6e83647 100644
--- a/docs/jdbct4ref_guide/src/asciidoc/index.adoc
+++ b/docs/jdbct4ref_guide/src/asciidoc/index.adoc
@@ -46,17 +46,10 @@
include::../../shared/license.txt[]
<<<
-include::resources/acknowledgements.txt[]
+include::../../shared/acknowledgements.txt[]
<<<
-*Revision History*
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 2.0.0 | To be announced.
-| 1.3.0 | January, 2016
-|===
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/jdbct4ref_guide/src/resources/acknowledgements.txt
----------------------------------------------------------------------
diff --git a/docs/jdbct4ref_guide/src/resources/acknowledgements.txt b/docs/jdbct4ref_guide/src/resources/acknowledgements.txt
deleted file mode 100644
index c395596..0000000
--- a/docs/jdbct4ref_guide/src/resources/acknowledgements.txt
+++ /dev/null
@@ -1,38 +0,0 @@
-*Acknowledgements*
-
-Microsoft�, Windows�, Windows NT�, Windows� XP, and Windows Vista� are
-U.S. registered trademarks of Microsoft Corporation. Intel� and Intel�
-Itanium� are trademarks of Intel Corporation in the U.S. and other
-countries. Java� is a registered trademark of Oracle and/or its
-affiliates. Motif, OSF/1, UNIX�, X/Open�, and the X device is a
-trademark of X/Open Company Ltd. in the UK and other countries.
-
-OSF, OSF/1, OSF/Motif, Motif, and Open Software Foundation are trademarks of
-the Open Software Foundation in the U.S. and other countries.
-� 1990, 1991, 1992, 1993 Open Software Foundation, Inc.
-
-The OSF documentation and the OSF software to which it relates are derived in
-part from materials supplied by the following: � 1987, 1988, 1989
-Carnegie-Mellon University. � 1989, 1990, 1991 Digital Equipment
-Corporation. � 1985, 1988, 1989, 1990 Encore Computer Corporation. � 1988 Free
-Software Foundation, Inc. � 1987, 1988, 1989, 1990, 1991 Hewlett-Packard
-Company. � 1985, 1987, 1988, 1989, 1990, 1991, 1992 International
-Business Machines Corporation. � 1988, 1989 Massachusetts Institute of
-Technology. � 1988, 1989, 1990 Mentat Inc. � 1988 Microsoft Corporation.
-� 1987, 1988, 1989, 1990, 1991,
-1992 SecureWare, Inc. � 1990, 1991 Siemens Nixdorf Informations systeme
-AG. � 1986, 1989, 1996, 1997 Sun Microsystems, Inc. � 1989, 1990, 1991
-Transarc Corporation.
-
-OSF software and documentation are based in part
-on the Fourth Berkeley Software Distribution under license from The
-Regents of the University of California. OSF acknowledges the following
-individuals and institutions for their role in its development: Kenneth
-C.R.C. Arnold, Gregory S. Couch, Conrad C. Huang, Ed James, Symmetric
-Computer Systems, Robert Elz. � 1980, 1981, 1982, 1983, 1985, 1986,
-1987, 1988, 1989 Regents of the University of California. OSF MAKES NO
-WARRANTY OF ANY KIND WITH REGARD TO THE OSF MATERIAL PROVIDED HEREIN,
-INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS FOR A PARTICULAR PURPOSE. OSF shall not be liable for errors
-contained herein or for incidental consequential damages in connection
-with the furnishing, performance, or use of this material.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/pom.xml
----------------------------------------------------------------------
diff --git a/docs/load_transform/pom.xml b/docs/load_transform/pom.xml
index d54b0e8..f811dde 100644
--- a/docs/load_transform/pom.xml
+++ b/docs/load_transform/pom.xml
@@ -184,6 +184,10 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -202,6 +206,10 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/_chapters/about.adoc b/docs/load_transform/src/asciidoc/_chapters/about.adoc
index f15fd04..48e2281 100644
--- a/docs/load_transform/src/asciidoc/_chapters/about.adoc
+++ b/docs/load_transform/src/asciidoc/_chapters/about.adoc
@@ -20,25 +20,25 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
-This guide describes how to load and transform data into a Trafodion database.
+This guide describes how to load and transform data into a {project-name} database.
-The information herein is complementary to the following Trafodion documentation:
+The information herein is complementary to the following {project-name} documentation:
-* http://trafodion.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual]
-* http://trafodion.apache.org/docs/odb/index.html[Trafodion odb User Guide]
+* {docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual]
+* {docs-url}/odb/index.html[{project-name} odb User Guide]
== Intended Audience
-This guide targets anyone wanting to load data into a Trafodion database.
+This guide targets anyone wanting to load data into a {project-name} database.
You need to have skills in the following areas to make full use of the information in this guide:
* SQL DDL and DML.
* Installation and configuration of Linux software.
-* Trafodion administration.
+* {project-name} administration.
* Depending on your data source, Java and/or Hadoop ecosystem usage.
== New and Changed Information
@@ -170,19 +170,8 @@ match-value [NOT] LIKE _pattern
[ESCAPE esc-char-expression]
```
-== Publishing History
-[cols="2*",options="header"]
-|===
-| Product Version | Publication Date
-| Trafodion Release 1.3.0 | January 2016.
-|===
-
== 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:
-
-issues@trafodion.incubator.apache.org
+We encourage 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 {project-support}.
-Include the document title and any comment, error found, or suggestion for improvement you have concerning this document. Or, even
-better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
+Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/_chapters/bulk_load.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/_chapters/bulk_load.adoc b/docs/load_transform/src/asciidoc/_chapters/bulk_load.adoc
index 46593b5..2866b23 100644
--- a/docs/load_transform/src/asciidoc/_chapters/bulk_load.adoc
+++ b/docs/load_transform/src/asciidoc/_chapters/bulk_load.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[bulk-load]]
@@ -28,20 +28,20 @@
The LOAD statement enables batch loading large volumes of data efficiently in a scalable manner.
-See the http://trafodion.apache.org/docs/sql_reference/index.html#load_statement[Trafodion SQL Reference Manual]
+See the {docs-url}/sql_reference/index.html#load_statement[{project-name} SQL Reference Manual]
for a full description of this SQL statement.
You can bulk-load data using one of the following methods:
-* <<bulk-load-data-from-trafodion-tables,Load Data From Trafodion Tables>>
+* <<bulk-load-data-from-trafodion-tables,Load Data From {project-name} Tables>>
* <<bulk-load-data-from-hdfs-files, Load Data From HDFS Files>>
* <<bulk-load-data-from-hive-tables,Load Data From Hive Tables>>
-* <<bulk-load-data-from-external-databases,Load Data From External Databases>>
+* <<bulk-load-data-from-external-databases, Load Data From External Databases>>
[[bulk-load-from-trafodion-tables]]
-== Load Data From Trafodion Tables
+== Load Data From {project-name} Tables
-You copy data between two Trafodion tables by using the appropriate SELECT statement in the LOAD command.
+You copy data between two {project-name} tables by using the appropriate SELECT statement in the LOAD command.
=== Example
@@ -57,24 +57,24 @@ to the HDFS folder containing the data. You may also specify a WHERE clause on t
See the https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-ExternalTables[External Tables]
page on the https://cwiki.apache.org/confluence/display/Hive[Hive Wiki] for more information.
-Trafodion can access columns in Hive tables having integer, string and char types.
+{project-name} can access columns in Hive tables having integer, string and char types.
See the https://cwiki.apache.org/confluence/display/Hive/LanguageManual+Types[LanguageManual Types]
page on the https://cwiki.apache.org/confluence/display/Hive[Hive Wiki] for the data types available in Hive.
Overall, you do the following:
1. Export the data on the local or remote cluster.
-2. If applicable, transport files to Trafodion cluster via FTP, scp, or some other method.
+2. If applicable, transport files to {project-name} cluster via FTP, scp, or some other method.
3. Use LOAD referencing HIVE external tables.
=== Example
-You have a customer-demographics in a text file, which you need to load into Trafodion.
+You have a customer-demographics in a text file, which you need to load into {project-name}.
The columns are separated by `|`.
Do the following:
-1. Using trafci, define the Trafodion table where you want to load the data.
+1. Using trafci, define the {project-name} table where you want to load the data.
+
```
CREATE TABLE customer_demographics_salt
@@ -121,7 +121,7 @@ LOCATION '/hive/tpcds/customer_demographics'
;
```
-4. Using trafci, load the Trafodion `customer_demographics_salt` table from the Hive table named
+4. Using trafci, load the {project-name} `customer_demographics_salt` table from the Hive table named
`hive.hive.customer_demographics`:
+
```
@@ -150,19 +150,19 @@ You can import data from Hive using the trafci or sqlci command interface. Do th
CQD HIVE_MAX_STRING_LENGTH '1000'; -- if the widest column is 1KB
```
+
-This setting is required if there are time-related column types in the target Trafodion table.
+This setting is required if there are time-related column types in the target {project-name} table.
+
```
CQD ALLOW_INCOMPATIBLE_ASSIGNMENT 'on';
```
-2. Issue the LOAD statement to load data into Trafodion tables from Hive. For example:
+2. Issue the LOAD statement to load data into {project-name} tables from Hive. For example:
+
```
LOAD WITH NO POPULATE INDEXES INTO trafodion.sch.demo SELECT * FROM hive.hive.demo;
```
-See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html#load_statement[Trafodion SQL Reference Manual].
+See the {docs-url}/sql_reference/index.html#load_statement[{project-name} SQL Reference Manual].
for the complete syntax of the LOAD statement.
If you use multiple LOAD statements to incrementally load sets of data into a single target table, then several HFiles are created
@@ -192,7 +192,7 @@ NOTE: The `major_compact` command returns immediately since it's not waited. Typ
You need to import data into Hive when loading data from external databases.
Use http://sqoop.apache.org/[Apache Sqoop], an open-source tools to move the data from the external database
-into Hive tables on the Trafodion cluster.
+into Hive tables on the {project-name} cluster.
Source data can be in the following formats:
@@ -221,9 +221,9 @@ introduction to Sqoop.
=== Install Required Software
-By default, Sqoop is not installed on Trafodion clusters. Do the following:
+By default, Sqoop is not installed on {project-name} clusters. Do the following:
-* Install and start Sqoop on the Trafodion cluster using either the Ambari or Cloudera Manager GUI.
+* Install and start Sqoop on the {project-name} cluster using either the Ambari or Cloudera Manager GUI.
See the http://sqoop.apache.org/docs/1.99.3/Installation.html[Sqoop installation instructions].
* Install http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html[JDK 1.8]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/_chapters/bulk_unload.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/_chapters/bulk_unload.adoc b/docs/load_transform/src/asciidoc/_chapters/bulk_unload.adoc
index 5ba2349..d9a1fac 100644
--- a/docs/load_transform/src/asciidoc/_chapters/bulk_unload.adoc
+++ b/docs/load_transform/src/asciidoc/_chapters/bulk_unload.adoc
@@ -20,22 +20,22 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[bulk-unload]]
= Bulk Unload
-The http://trafodion.apache.org/docs/sql_reference/index.html#unload_statement[UNLOAD] statement is a
-Trafodion extension that exports data from Trafodion tables into an HDFS location that you specify.
-Refer to the http://trafodion.apache.org/docs/sql_reference/index.html#unload_statement[Trafodion SQL Reference Manual]
+The {docs-url}/sql_reference/index.html#unload_statement[UNLOAD] statement is a
+{project-name} extension that exports data from {project-name} tables into an HDFS location that you specify.
+Refer to the {docs-url}/sql_reference/index.html#unload_statement[{project-name} SQL Reference Manual]
for complete documentation.
The extracted data can be either compressed or uncompressed based on what you choose.
UNLOAD performs multiple steps based on the options you give; for example:
* If using snapshot scan:
-** Get list of Trafodion tables from the query plan.
+** Get list of {project-name} tables from the query plan.
** Create/verify snapshots.
* Purge target location, if specified
@@ -50,7 +50,7 @@ UNLOAD performs multiple steps based on the options you give; for example:
*Example*
This example shows how the UNLOAD statement extracts data from a
-Trafodion table, `TRAFODION.HBASE.CUSTOMER_DEMOGRAPHICS`, into an HDFS
+{project-name} table, `TRAFODION.HBASE.CUSTOMER_DEMOGRAPHICS`, into an HDFS
folder, `/bulkload/customer_demographics`:
```
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/_chapters/introduction.adoc b/docs/load_transform/src/asciidoc/_chapters/introduction.adoc
index 05e0cd5..aad3a56 100644
--- a/docs/load_transform/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/load_transform/src/asciidoc/_chapters/introduction.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[introduction]]
@@ -28,13 +28,13 @@
[[introduction-load-methods]]
== Load Methods
-There are two methods used to load data into a Trafodion table. Both methods can run while the database is concurrently queried:
+There are two methods used to load data into a {project-name} table. Both methods can run while the database is concurrently queried:
[cols="20%,40%,40%",options="header"]
|===
| Type | Description | Methods/Tools
| *Bulk Load* | Large data volumes +
-Stage data and load in the batches | Trafodion Bulk Loader
+Stage data and load in the batches | {project-name} Bulk Loader
| *Trickle Load* | Small data volumes +
Insert data as it arrives | ETL tool +
Custom ODBC/JDBC application +
@@ -45,21 +45,21 @@ odb Tool
These two methods use four types of SQL insert statements
* *Bulk Load*
-** http://trafodion.incubator.apache.org/docs/sql_reference/index.html#load_statement[LOAD]
+** {docs-url}/sql_reference/index.html#load_statement[LOAD]
* *Trickle Load*
-** http://trafodion.incubator.apache.org/docs/sql_reference/index.html#insert_statement[INSERT]
-** http://trafodion.incubator.apache.org/docs/sql_reference/index.html#upsert_statement[UPSERT]
-** http://trafodion.incubator.apache.org/docs/sql_reference/index.html#upsert_statement[UPSERT USING LOAD]
+** {docs-url}/sql_reference/index.html#insert_statement[INSERT]
+** {docs-url}/sql_reference/index.html#upsert_statement[UPSERT]
+** {docs-url}/sql_reference/index.html#upsert_statement[UPSERT USING LOAD]
-The http://trafodion.incubator.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual]
+The {docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual]
provides syntax descriptions for these statements.
The data source defines what type of load approach and method you use:
* *Bulk Load* (LOAD statement)
** _Text Files_: Map an external Hive table.
-** _JDBC-Compliant Database_: Load into Hive on the Trafodion cluster using `sqoop`.
+** _JDBC-Compliant Database_: Load into Hive on the {project-name} cluster using `sqoop`.
** _Hive Tables_: Direct load.
** _Native HBase Tables_: Direct load.
** _Disparate Data Source_: Write Java/C++ UDF to read data from source and pass rows to LOAD.
@@ -79,7 +79,7 @@ For more information, refer to:
[[introduction-insert-types]]
=== Insert Types
-The following insert types are supported in Trafodion:
+The following insert types are supported in {project-name}:
* `INSERT INTO T …`
* `UPSERT INTO T …`
@@ -104,7 +104,7 @@ The following table compares the different insert types:
Throughput, max/min sizes depends on multiple factors:
-* Format of rows in Trafodion table (aligned format or not).
+* Format of rows in {project-name} table (aligned format or not).
* Length of row.
* Number of columns in row.
* Data type of columns.
@@ -115,7 +115,7 @@ Throughput, max/min sizes depends on multiple factors:
== Unload
-The Trafodion UNLOAD statement exports data from Trafodion tables into an HDFS directory. Refer to <<bulk-unload,Bulk Unload>> for more information.
+The {project-name} UNLOAD statement exports data from {project-name} tables into an HDFS directory. Refer to <<bulk-unload,Bulk Unload>> for more information.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/load_transform/src/asciidoc/_chapters/monitor.adoc
----------------------------------------------------------------------
diff --git a/docs/load_transform/src/asciidoc/_chapters/monitor.adoc b/docs/load_transform/src/asciidoc/_chapters/monitor.adoc
index ab66bf8..cfe1492 100644
--- a/docs/load_transform/src/asciidoc/_chapters/monitor.adoc
+++ b/docs/load_transform/src/asciidoc/_chapters/monitor.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[monitor-progress]]
@@ -28,12 +28,12 @@
== INSERT and UPSERT
-For an INSERT statement, rows are written to the HBase table that represents the Trafodion table when the transaction commits.
+For an INSERT statement, rows are written to the HBase table that represents the {project-name} table when the transaction commits.
It is more difficult to see query progress here.
== UPSERT USING LOAD
-For an UPSERT USING LOAD statement, rows added are visible in the Trafodion table after each `ListOfPut` call succeeds.
+For an UPSERT USING LOAD statement, rows added are visible in the {project-name} table after each `ListOfPut` call succeeds.
You can use a `SELECT COUNT(*)` statement to monitor progress. That way, you know how many rows are already in the table when the
statement starts executing.
@@ -58,7 +58,7 @@ lsof +L1 | grep SCR | wc -l
This command returns a count of the number of overflow files for sort. Each file is 2GB in size.
You need to have an approximate idea of the volume of data being loaded to know how much more
data needs to be sorted. On a cluster, sort is done on all nodes with a pdsh-like utility.
-Trafodion data volume can also be larger than Hive data volume by a factor of 2 or 3.
+{project-name} data volume can also be larger than Hive data volume by a factor of 2 or 3.
In step 3, create prep HFiles, use the following command to monitor the volume of data written
out to the staging directory:
[08/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/_chapters/sql_utilities.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/_chapters/sql_utilities.adoc b/docs/sql_reference/src/asciidoc/_chapters/sql_utilities.adoc
index 4de3903..d386e64 100644
--- a/docs/sql_reference/src/asciidoc/_chapters/sql_utilities.adoc
+++ b/docs/sql_reference/src/asciidoc/_chapters/sql_utilities.adoc
@@ -20,52 +20,52 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[sql_utilities]]
= SQL Utilities
-A utility is a tool that runs within Trafodion SQL and performs tasks.
-This section describes the Trafodion SQL utilities:
+A utility is a tool that runs within {project-name} SQL and performs tasks.
+This section describes the {project-name} SQL utilities:
[cols=","]
|===
-| <<load_statement,LOAD Statement>> | Uses the Trafodion Bulk Loader to load data from a source table, either
-a Trafodion table or a Hive table, into a target Trafodion table.
+| <<load_statement,LOAD Statement>> | Uses the {project-name} Bulk Loader to load data from a source table, either
+a {project-name} table or a Hive table, into a target {project-name} table.
| <<populate_index_utility,POPULATE INDEX Utility>> | Loads indexes.
| <<purgedata_utility,PURGEDATA Utility>> | Purges data from tables and indexes.
-| <<unload_statement,UNLOAD Statement>> | Unloads data from Trafodion tables into an HDFS location that you
+| <<unload_statement,UNLOAD Statement>> | Unloads data from {project-name} tables into an HDFS location that you
specify.
| <<update_statistics_statement,UPDATE STATISTICS Statement>> | Updates the histogram statistics for one or more groups of columns
within a table. These statistics are used to devise optimized access plans.
|===
-NOTE: Trafodion SQL utilities are entered interactively or from script
-files using a client-based tool, such as the Trafodion Command Interface
+NOTE: {project-name} SQL utilities are entered interactively or from script
+files using a client-based tool, such as the {project-name} Command Interface
(TrafCI). To install and configure a client application that enables you
to connect to and issue SQL utilities, see the
-http://trafodion.incubator.apache.org/docs/client_installation/index.html[_Trafodion Client Installation Guide_].
+{docs-url}/client_installation/index.html[_{project-name} Client Installation Guide_].
<<<
[[load_statement]]
== LOAD Statement
-The LOAD statement uses the Trafodion Bulk Loader to load data from a
-source table, either a Trafodion table or a Hive table, into a target
-Trafodion table. The Trafodion Bulk Loader prepares and loads HFiles
+The LOAD statement uses the {project-name} Bulk Loader to load data from a
+source table, either a {project-name} table or a Hive table, into a target
+{project-name} table. The {project-name} Bulk Loader prepares and loads HFiles
directly in the region servers and bypasses the write path and the cost
associated with it. The write path begins at a client, moves to a region
server, and ends when data eventually is written to an HBase data file
called an HFile.
-The Trafodion bulk load process takes place in the following phases:
+The {project-name} bulk load process takes place in the following phases:
* *Disable Indexes* (if incremental index build not used)
* *Prepare* (takes most time, heart of the bulk load operation)
-** Read source files (Trafodion Table, Hive table, or Hive external table)
-** Data encoded in Trafodion encoding
+** Read source files ({project-name} Table, Hive table, or Hive external table)
+** Data encoded in {project-name} encoding
** Data repartitioned and sorted to match regions of target table
** Data written to HFiles
** Data repartitioned and written to index HFiles (if incremental index build IS used)
@@ -80,7 +80,7 @@ The Trafodion bulk load process takes place in the following phases:
* *Cleanup*
** HFiles temporary space cleanup
-LOAD is a Trafodion SQL extension.
+LOAD is a {project-name} SQL extension.
```
LOAD [WITH option[[,] option]...] INTO target-table SELECT ... FROM source-table
@@ -100,15 +100,15 @@ option is:
* `_target-table_`
+
-is the name of the target Trafodion table where the data will be loaded.
+is the name of the target {project-name} table where the data will be loaded.
See <<database_object_names,Database Object Names>>.
* `_source-table_`
+
-is the name of either a Trafodion table or a Hive table that has the
-source data. Hive tables can be accessed in Trafodion using the
+is the name of either a {project-name} table or a Hive table that has the
+source data. Hive tables can be accessed in {project-name} using the
HIVE.HIVE schema (for example, hive.hive.orders). The Hive table needs
-to already exist in Hive before Trafodion can access it. If you want to
+to already exist in Hive before {project-name} can access it. If you want to
load data that is already in an HDFS folder, then you need to create an
external Hive table with the right fields and pointing to the HDFS
folder containing the data. You can also specify a WHERE clause on the
@@ -187,10 +187,10 @@ guidelines.
==== Staging Folder for HFiles
The Bulk Loader uses an HDFS folder as a staging area for the HFiles
-before calling HBase APIs to merge them into the Trafodion table.
+before calling HBase APIs to merge them into the {project-name} table.
-By default, Trafodion uses /bulkload as the staging folder. This folder
-must be owned by the same user as the one under which Trafodion runs. Trafodion
+By default, {project-name} uses /bulkload as the staging folder. This folder
+must be owned by the same user as the one under which {project-name} runs. {project-name}
also must have full permissions on this folder. The HBase user (that is,
the user under which HBase runs) must have read/write access to this
folder.
@@ -284,7 +284,7 @@ Direct access for Hive table data supports:
Tables must be created/dropped/altered through Hive itself.
-Trafodion:
+{project-name}:
* Reads Hive metadata to determine information about table.
* UPDATE STATISTICS can be performed on Hive tables - improves performance!
@@ -316,7 +316,7 @@ row format delimited fields terminated by '|' location
'/hive/tpcds/customer_demographics';
```
-* The Trafodion table where you want to load the data is defined using
+* The {project-name} table where you want to load the data is defined using
this DDL:
+
```
@@ -520,11 +520,11 @@ PURGEDATA myschema.mytable;
[[unload_statement]]
== UNLOAD Statement
-The UNLOAD statement unloads data from Trafodion tables into an HDFS
+The UNLOAD statement unloads data from {project-name} tables into an HDFS
location that you specify. Extracted data can be either compressed or
uncompressed based on what you choose.
-UNLOAD is a Trafodion SQL extension.
+UNLOAD is a {project-name} SQL extension.
```
UNLOAD [WITH option[ option]...] INTO 'target-location' SELECT ... FROM source-table ...
@@ -555,19 +555,19 @@ The number of files created will equal the number of ESPs.
* `SELECT … FROM _source-table_ …`
+
is either a simple query or a complex one that contains GROUP BY, JOIN,
-or UNION clauses. _source-table_ is the name of a Trafodion table that
+or UNION clauses. _source-table_ is the name of a {project-name} table that
has the source data. See <<database_object_names,Database Object Names>>.
* `[WITH _option_[ _option_]…]`
+
is a set of options that you can specify for the unload operation. If
-you specify an option more than once, Trafodion returns an error with
+you specify an option more than once, {project-name} returns an error with
SQLCODE -4489. You can specify one or more of these options:
** `DELIMITER { '_delimiter-string_' | _delimiter-ascii-value_ }`
+
specifies the delimiter as either a delimiter string or an ASCII value.
-If you do not specify this option, Trafodion uses the character "|" as
+If you do not specify this option, {project-name} uses the character "|" as
the delimiter.
*** _delimiter-string_ can be any ASCII or Unicode string. You can also
@@ -613,7 +613,7 @@ merges the unloaded files into one single file in the specified
_merged-file-path_. If you specify compression, the unloaded data will
be in compressed format, and the merged file will also be in compressed
format. If you specify the optional OVERWRITE keyword, the file is
-overwritten if it already exists; otherwise, Trafodion raises an error
+overwritten if it already exists; otherwise, {project-name} raises an error
if the file already exists.
** `NO OUTPUT`
@@ -626,7 +626,7 @@ that the Bulk Unloader is executing.
* `{ NEW | EXISTING } SNAPSHOT HAVING SUFFIX '_string_'`
+
initiates an HBase snapshot scan during the unload operation. During a
-snapshot scan, the Bulk Unloader will get a list of the Trafodion tables
+snapshot scan, the Bulk Unloader will get a list of the {project-name} tables
from the query explain plan and will create and verify snapshots for the
tables. Specify a suffix string, '_string_', which will be appended to
each table name.
@@ -635,7 +635,7 @@ each table name.
=== Considerations for UNLOAD
* You must have write permissions on the target HDFS folder.
-* If a WITH option is specified more than once, Trafodion returns an
+* If a WITH option is specified more than once, {project-name} returns an
error with SQLCODE -4489.
[[unload_required_privileges]]
@@ -653,7 +653,7 @@ component.
=== Examples of UNLOAD
* This example shows how the UNLOAD statement extracts data from a
-Trafodion table, `TRAFODION.HBASE.CUSTOMER_DEMOGRAPHICS`, into an HDFS
+{project-name} table, `TRAFODION.HBASE.CUSTOMER_DEMOGRAPHICS`, into an HDFS
folder, `/bulkload/customer_demographics`:
+
```
@@ -683,7 +683,7 @@ The UPDATE STATISTICS statement updates the histogram statistics for one
or more groups of columns within a table. These statistics are used to
devise optimized access plans.
-UPDATE STATISTICS is a Trafodion SQL extension.
+UPDATE STATISTICS is a {project-name} SQL extension.
```
UPDATE STATISTICS FOR TABLE table [CLEAR | on-clause]
@@ -863,7 +863,7 @@ the optimizer to generate good plans.
+
If you do not specify the SAMPLE clause, if the table has fewer rows
than specified, or if the sample size is greater than the system limit,
-Trafodion SQL reads all rows from _table_. See <<sample_clause,SAMPLE Clause>>.
+{project-name} SQL reads all rows from _table_. See <<sample_clause,SAMPLE Clause>>.
*** `_sample-option_`
@@ -875,7 +875,7 @@ be an integer that is greater than zero
<<<
**** `RANDOM _percent_ PERCENT`
+
-directs Trafodion SQL to choose rows randomly from the table. The value
+directs {project-name} SQL to choose rows randomly from the table. The value
percent must be a value between zero and 100 (0 < percent <= 100). In
addition, only the first four digits to the right of the decimal point
are significant. For example, value 0.00001 is considered to be 0.0000,
@@ -883,7 +883,7 @@ Value 1.23456 is considered to be 1.2345.
**** `PERIODIC _size_ ROWS EVERY _period_ ROW`
+
-directs Trafodion SQL to choose the first _size_ number of rows from
+directs {project-name} SQL to choose the first _size_ number of rows from
each _period_ of rows. The value _size_ must be an integer that is
greater than zero and less than or equal to the value _period_. (0 <
_size_ <= _period_). The size of the _period_ is defined by the number
@@ -900,7 +900,7 @@ Use UPDATE STATISTICS to collect and save statistics on columns. The SQL
compiler uses histogram statistics to determine the selectivity of
predicates, indexes, and tables. Because selectivity directly influences
the cost of access plans, regular collection of statistics increases the
-likelihood that Trafodion SQL chooses efficient access plans.
+likelihood that {project-name} SQL chooses efficient access plans.
While UPDATE STATISTICS is running on a table, the table is active and
available for query access.
@@ -1022,7 +1022,7 @@ control query default USTAT_AUTOMATION_INTERVAL '1440';
```
The value of USTAT_AUTOMATION_INTERVAL is intended to be an automation
-interval (in minutes), but, in Trafodion Release 1.0, this value does
+interval (in minutes), but, in {project-name} Release 1.0, this value does
not act as a timing interval. Instead, any value greater than zero
enables update statistics automation.
@@ -1033,7 +1033,7 @@ that you want to optimize. For example:
prepare s from select...;
```
-The PREPARE statement causes the Trafodion SQL compiler to compile and
+The PREPARE statement causes the {project-name} SQL compiler to compile and
optimize a query without executing it. When preparing queries with
update statistic automation enabled, any histograms needed by the
optimizer that are not present will cause those columns to be marked as
@@ -1064,7 +1064,7 @@ ON (jobcode),(empnum, deptnum) GENERATE 10 INTERVALS;
* This example generates histogram statistics using the ON EVERY COLUMN
option for the table DEPT. This statement performs a full scan, and
-Trafodion SQL determines the default number of intervals.
+{project-name} SQL determines the default number of intervals.
+
```
UPDATE STATISTICS FOR TABLE dept ON EVERY COLUMN;
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/sql_reference/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/sql_reference/src/asciidoc/index.adoc b/docs/sql_reference/src/asciidoc/index.adoc
index 0d8f81e..f9ffad6 100644
--- a/docs/sql_reference/src/asciidoc/index.adoc
+++ b/docs/sql_reference/src/asciidoc/index.adoc
@@ -32,7 +32,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
:images: ../images
:leveloffset: 1
@@ -41,26 +42,12 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-*License Statement*
+include::../../shared/license.txt[]
+<<<
+include::../../shared/acknowledgements.txt[]
-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.
-
-*Acknowledgements*
-
-Microsoft(R) and Windows(R) are U.S. registered trademarks of Microsoft Corporation. Java(R) is a registered trademark of Oracle and/or its affiliates.
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
[04/22] incubator-trafodion git commit: Change logation of incubator
logo.
Posted by db...@apache.org.
Change logation of incubator logo.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/a3cc57d7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/a3cc57d7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/a3cc57d7
Branch: refs/heads/master
Commit: a3cc57d7f87c8f89148fe34f729e9c630e9e2091
Parents: c2116c2
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Fri Apr 29 00:16:17 2016 -0600
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Fri Apr 29 00:16:17 2016 -0600
----------------------------------------------------------------------
docs/src/site/resources/css/site.css | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/a3cc57d7/docs/src/site/resources/css/site.css
----------------------------------------------------------------------
diff --git a/docs/src/site/resources/css/site.css b/docs/src/site/resources/css/site.css
index 2ffedf5..e28a4a4 100644
--- a/docs/src/site/resources/css/site.css
+++ b/docs/src/site/resources/css/site.css
@@ -36,7 +36,7 @@
.logo-right {
position: absolute;
- right: 300px;
+ right: 200px;
}
.color-highlight {
[13/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc
index 21f7156..fe68028 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[udr-server-and-language-manager-messages]]
@@ -35,11 +35,11 @@ MXUDR: Unable to allocate memory for object <object-name>.
Where <object-name> is the name of the object.
-*Cause:* The Trafodion UDR server was not able to obtain enough memory to allocate the named object.
+*Cause:* The {project-name} UDR server was not able to obtain enough memory to allocate the named object.
-*Effect:* The request message is rejected, and the Trafodion statement fails.
+*Effect:* The request message is rejected, and the {project-name} statement fails.
-*Recovery:* Stop and start the client process to restart a new Trafodion UDR server,
+*Recovery:* Stop and start the client process to restart a new {project-name} UDR server,
and retry the stored procedure call.
[[SQL-11201]]
@@ -57,10 +57,10 @@ method was not found.
*Effect:* The operation fails.
-*Recovery:* Check the installation of the Trafodion platform for Java
-product and the Trafodion language manager. Verify the
+*Recovery:* Check the installation of the {project-name} platform for Java
+product and the {project-name} language manager. Verify the
existence of the specified class. Stop and restart the session, and
-retry the Trafodion statement.
+retry the {project-name} statement.
<<<
[[SQL-11202]]
@@ -74,8 +74,8 @@ Language Manager initialization failed. Details: Unable to initialize the Java v
*Effect:* The operation fails.
-*Recovery:* Check the installation of the Trafodion platform for Java
-product. Stop and restart the session, and retry the Trafodion statement.
+*Recovery:* Check the installation of the {project-name} platform for Java
+product. Stop and restart the session, and retry the {project-name} statement.
[[SQL-11221]]
== SQL 11221
@@ -85,11 +85,11 @@ Language Manager is out of memory <string>.
```
*Cause:* The language manager could not acquire enough memory to
-complete its work on the Trafodion statement.
+complete its work on the {project-name} statement.
*Effect:* The operation fails.
-*Recovery:* Stop and restart the session and retry the Trafodion
+*Recovery:* Stop and restart the session and retry the {project-name}
statement.
<<<
@@ -100,13 +100,13 @@ statement.
The operation failed because the Java Virtual Machine ran out of memory.
```
-*Cause:* The Java Virtual Machine, hosted by a Trafodion UDR
+*Cause:* The Java Virtual Machine, hosted by a {project-name} UDR
server, did not have enough memory to execute a Java method. This error
condition will be accompanied by another condition that shows when the
Java Virtual Machine encountered the error.
*Effect:* The operation fails.
-*Recovery:* Stop and restart the session and retry the Trafodion statement.
+*Recovery:* Stop and restart the session and retry the {project-name} statement.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/index.adoc b/docs/messages_guide/src/asciidoc/index.adoc
index 7bd23e8..1cedf3b 100644
--- a/docs/messages_guide/src/asciidoc/index.adoc
+++ b/docs/messages_guide/src/asciidoc/index.adoc
@@ -32,7 +32,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
:images: ../images
:sourcedir: ../../resources/source
@@ -43,22 +44,10 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-*License Statement*
+include::../../shared/license.txt[]
-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.
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/pom.xml
----------------------------------------------------------------------
diff --git a/docs/odb_user/pom.xml b/docs/odb_user/pom.xml
index c154229..0ad3324 100644
--- a/docs/odb_user/pom.xml
+++ b/docs/odb_user/pom.xml
@@ -183,6 +183,10 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -201,6 +205,10 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc b/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc
index 0bc5184..113718b 100644
--- a/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
== A. Troubleshooting
@@ -89,7 +89,7 @@ then you should use an *empty string* as catalog name.
+
NOTE: Some flawed ODBC Drivers unfortunately want NULL here — instead of *empty strings* as it should be.
-5. You can have errors loading `TIME(N)` fields with` N>0` under Trafodion because the
+5. You can have errors loading `TIME(N)` fields with` N>0` under {project-name} because the
ODBC Driver does not manage the field display size when `N>0`.
6. If you have problems starting odb on Unix/Linux check:
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/about.adoc b/docs/odb_user/src/asciidoc/_chapters/about.adoc
index 5e418ff..9b00e47 100644
--- a/docs/odb_user/src/asciidoc/_chapters/about.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/about.adoc
@@ -20,20 +20,20 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
-This guide describes how to use odb, a multi-threaded, ODBC-based command-line tool, to perform various operations on a Trafodion
+This guide describes how to use odb, a multi-threaded, ODBC-based command-line tool, to perform various operations on a {project-name}
database.
-NOTE: In Trafodion Release 1.3, only loading, extracting, and copying data operations are production ready, meaning that that have
+NOTE: In {project-name} Release 1.3, only loading, extracting, and copying data operations are production ready, meaning that that have
been fully tested and are ready to be used in a production environment. +
+
Other features are designated as _Technology Preview_ meaning that they have not been fully tested and are not ready for production use.
== Intended Audience
-This guide is intended for database administrators and other users who want to run scripts that operate on a Trafodion database, primarily for
+This guide is intended for database administrators and other users who want to run scripts that operate on a {project-name} database, primarily for
parallel data loading.
== New and Changed Information
@@ -167,20 +167,8 @@ 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:
-
-issues@trafodion.incubator.apache.org
+We encourage 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 {project-support}.
Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
-Or, even better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc b/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc
index c427652..21b8e11 100644
--- a/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
<<<
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc b/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc
index 5d2e1b3..32a1a6d 100644
--- a/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Comparing Tables (Technology Preview)
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/concepts.adoc b/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
index 8faff01..5a79855 100644
--- a/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Basic Concepts
@@ -107,7 +107,7 @@ Data loading options [connection required]:
* pc: no default. Also <ASCII_dec> 0<ASCII_OCT> X<ASCII_HEX>
* direct: only for Vertica databases
* bpc: default 1,bpwc: default 4
- * loadcmd: default IN. only for Trafodion databases
+ * loadcmd: default IN. only for {project-name} databases
Data extraction options [connection required]:
-e {src={table|-file}|sql=<custom sql>}:tgt=[+]file[:pwhere=where_cond]
[:fs=fieldsep][:rs=recsep][:sq=stringqualifier][:ec=escape_char][:soe]
@@ -139,7 +139,7 @@ Data copy options [connection required]:
* ucs2toutf8: default is 'skip'
* roe: default 3 if no arguments
* bpc: default 1,bpwc: default 4
- * loadcmd: default IN. only for Trafodion databases
+ * loadcmd: default IN. only for {project-name} databases
Data pipe options [connection required]:
-pipe sql={[sqlcmd]|@sqlscript|-file}:tgtsql={@sqlfile|[sqlcmd]}[:soe]
[:rows=#rowset][:nomark][:max=#max_rec][:bpc=#][:bpwc=#][:errdmp=file]
@@ -314,7 +314,7 @@ Describing: TRAFODION.MAURIZIO.T11
The `INDEX` column (when using type `T`) contains the following information:
-* `name` of the `INDEX` (in Trafodion indexes having the same name as the table are Primary Keys).
+* `name` of the `INDEX` (in {project-name} indexes having the same name as the table are Primary Keys).
* `ordinal number` to identify the order of that field in the index.
* `(U)nique o (M)ultiple` values allowed.
* `(+)` means that more than one index includes that field.
@@ -806,7 +806,7 @@ If you have 16 threads and `\u2013d MYDSN`:
| `15` | `MYDSN8` | `MYDSN8`
|===
-This technique has been used to maximize extraction throughput from a multi-segment Trafodion system.
+This technique has been used to maximize extraction throughput from a multi-segment {project-name} system.
Each (local) Data Source was *linked* to a corresponding remote Data Source extracting its own data through its
own network interface card.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/install.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/install.adoc b/docs/odb_user/src/asciidoc/_chapters/install.adoc
index b6df5b9..d505a49 100644
Binary files a/docs/odb_user/src/asciidoc/_chapters/install.adoc and b/docs/odb_user/src/asciidoc/_chapters/install.adoc differ
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/introduction.adoc b/docs/odb_user/src/asciidoc/_chapters/introduction.adoc
index 3357f21..d34b48d 100644
--- a/docs/odb_user/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/introduction.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ 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 @@@
- */
+*@@@ 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 @@@
+*/
////
= Introduction
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/load.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/load.adoc b/docs/odb_user/src/asciidoc/_chapters/load.adoc
index b735b7a..9d2f669 100644
--- a/docs/odb_user/src/asciidoc/_chapters/load.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/load.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Load, Extract, Copy
@@ -41,7 +41,7 @@ This command:
* using `|` (vertical bar) as a field separator (`fs=\|`)
* using `1000 rows` as row-set buffer (`rows=1000`)
* using `UPSERT USING LOAD` syntax to achieve better throughput as described in
-http://trafodion.incubator.apache.org/docs/load_transform/index.html[Trafodion Load and Transform Guide]
+{docs-url}/load_transform/index.html[{project-name} Load and Transform Guide]
* truncating the target table before loading (`truncate`)
* using `4 parallel threads` to load the target table (`parallel=4`)
@@ -162,7 +162,7 @@ specified, then odb loads node-attributes values.
odb loads the first node/attribute to the first column, the second node/attribute to the second column and so on without checking node/attribute names.
| `xmldump` | odb does not load the XML file content. Instead, XML attribute/tage names are printed to standard output so you can check
what is going to be loaded.
-| `loadcmd` | SQL operation to be used for load. (Default: `INSERT`). `UPSERT` and `UPSERT USING LOAD` are also available for Trafodion.
+| `loadcmd` | SQL operation to be used for load. (Default: `INSERT`). `UPSERT` and `UPSERT USING LOAD` are also available for {project-name}.
|===
You can load multiple files using different `-l` options. By default odb creates as many threads (and ODBC connections) as the sum of
@@ -558,7 +558,7 @@ has generated and loaded 1M rows of _realistic_ data in about ten seconds:
== Load Default Values
The simpler way to load database generated defaults is to ignore the associated columns in the map file. For example, suppose you have a
-table like this under Trafodion:
+table like this under {project-name}:
```
create table TRAFODION.maurizio.dtest
@@ -928,7 +928,7 @@ features *for each extraction thread*. +
+
*Examples* +
+
-1. You want *Trafodion* to ignore missing stats warning. Then you can run via `mpre` a SQL script containing: +
+1. You want *{project-name}* to ignore missing stats warning. Then you can run via `mpre` a SQL script containing: +
+
`control query default HIST_MISSING_STATS_WARNING_LEVEL '0';` +
+
@@ -975,7 +975,7 @@ Please note the `src=-tlist.txt`.
<<<
== Copy Tables From One Database to Another
-odb can directly copy tables from one data-source to another. For example, from Trafodion to Teradata or vice-versa).
+odb can directly copy tables from one data-source to another. For example, from {project-name} to Teradata or vice-versa).
Data *_never lands to disk_* when using this option.
The target table has to be be created in advance and should have a compatible structure.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc b/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc
index c331107..ce49729 100644
--- a/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= odb as a Query Driver (Technology Preview)
@@ -112,7 +112,7 @@ SET QLABEL <label>
```
~/Devel/odb $ cat script.sql
--- Trafodion TPC-H Query 1 SET QLABEL Q01
+-- {project-name} TPC-H Query 1 SET QLABEL Q01
SELECT
L_RETURNFLAG
, L_LINESTATUS
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc b/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc
index 491afd7..0be4a07 100644
--- a/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= odb as a SQL Interpreter (Technology Preview)
@@ -101,7 +101,7 @@ will be just prepared, not executed.
<<<
10. Different databases use different commands to set default schema(s):
-* Trafodion: `set schema <name>;`
+* {project-name}: `set schema <name>;`
* MySQL: `use <name>;`
* PostgreSQL/Vertica: `set search_path to <name1,name2,\u2026>;`
* Teradata: `set database <name>;`
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/index.adoc b/docs/odb_user/src/asciidoc/index.adoc
index 84ae2f9..e07063c 100644
--- a/docs/odb_user/src/asciidoc/index.adoc
+++ b/docs/odb_user/src/asciidoc/index.adoc
@@ -33,7 +33,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
// Define variables used in the document.
:images: ../images
@@ -43,22 +44,10 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-**License Statement**
+include::../../shared/license.txt[]
-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.
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/pom.xml
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/pom.xml b/docs/provisioning_guide/pom.xml
index eb7b4c3..70f80b0 100644
--- a/docs/provisioning_guide/pom.xml
+++ b/docs/provisioning_guide/pom.xml
@@ -184,6 +184,11 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
+ <download-url>http://trafodion.incubator.apache.org/download.html</download-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -202,6 +207,11 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
+ <download-url>http://trafodion.incubator.apache.org/download.html</download-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc
index b5a67e9..c751ed3 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc
@@ -20,35 +20,35 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
-This guide describes how to provision the end-user Trafodion binaries on top of an existing Hadoop environment. This install allows you to store and query data using Trafodion, either via Trafodion clients
-(see http://trafodion.incubator.apache.org/client_install/index.html[Trafodion Client Installation Guide] or via application code you write.
+This guide describes how to provision the end-user {project-name} binaries on top of an existing Hadoop environment. This install allows you to store and query data using {project-name}, either via {project-name} clients
+(see {docs-url}/client_install/index.html[{project-name} Client Installation Guide] or via application code you write.
If you want to install a Trafodion developer-build environment, then please refer to the
http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for instructions.
== Intended Audience
This guide assumes that you are well-versed in Linux and Hadoop administration. If you don't have such experience, then
-you should consider going through the steps required to install a Hadoop environment before attempting to install Trafodion.
+you should consider going through the steps required to install a Hadoop environment before attempting to install {project-name}.
The instructions contained herein apply to the following environments.
-* *Single-Node Environments*: Typically used when you want to evaluate Trafodion.
-* *Cluster (Multi-Node) Environments*: Typically used when you deploy Trafodion for application usage.
+* *Single-Node Environments*: Typically used when you want to evaluate {project-name}.
+* *Cluster (Multi-Node) Environments*: Typically used when you deploy {project-name} for application usage.
-NOTE: Trafodion can be provisioned on a single-node or multi-node environment. Unless specifically noted, the term *cluster* is used
+NOTE: {project-name} can be provisioned on a single-node or multi-node environment. Unless specifically noted, the term *cluster* is used
to mean both single- and multi-node environments.
The provisioning instructions applies to a diverse set of platforms:
-* *Virtual Machines*: Often used for evaluations and Trafodion development.
+* *Virtual Machines*: Often used for evaluations and {project-name} development.
* *Cloud*: Used for Product Environments as well as for Developer Environments.
* *Bare Metal*: Used for Product Environments as well as for Developer Environments.
-NOTE: The term *node* is used to represent a computing platform on which operating system, Hadoop, and Trafodion software is running.
+NOTE: The term *node* is used to represent a computing platform on which operating system, Hadoop, and {project-name} software is running.
Unless specifically qualified (bare-metal node, virtual-machine node, or cloud-node), *node* represents a computing platform in your cluster
regardless of platform type.
@@ -181,19 +181,8 @@ match-value [NOT] LIKE _pattern
[ESCAPE esc-char-expression]
```
-== Publishing History
-[cols="2*",options="header"]
-|===
-| Product Version | Publication Date
-| Trafodion Release 1.3.0 | January 2016.
-|===
-
== 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:
-
-issues@trafodion.incubator.apache.org
+We encourage 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 {project-support}.
-Include the document title and any comment, error found, or suggestion for improvement you have concerning this document. Or, even
-better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
+Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc
index 56cecdd..1e5017a 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc
@@ -20,30 +20,30 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[activate]]
= Activate
[[activate-manage-trafodion]]
-== Manage Trafodion
+== Manage {project-name}
-You use the Trafodion runtime user ID to perform Trafodion management operations.
+You use the {project-name} runtime user ID to perform {project-name} management operations.
-The following table provides an overview of the different Trafodion management scripts.
+The following table provides an overview of the different {project-name} management scripts.
[cols="40%,20%l,20%l,20%l",options="header"]
|===
| Component | Start | Stop | Status
-| *All of Trafodion* | sqstart | sqstop | sqcheck
+| *All of {project-name}* | sqstart | sqstop | sqcheck
| *RMS Server* | rmsstart | rmsstop | rmscheck
| *REST Server* | reststart | reststop | -
| *LOB Server* | lobstart | lobstop | -
| *DCS (Database Connectivity Services)* | dcsstart | dcsstop | dcscheck
|===
-*Example: Start Trafodion*
+*Example: Start {project-name}*
```
cd $MY_SQROOT/sql/scripts
@@ -52,13 +52,13 @@ sqcheck
```
[[activate-validate-trafodion-installation]]
-== Validate Trafodion Installation
+== Validate {project-name} Installation
You can use sqlci (part of the base product) or trafci (requires separate install; see the
-http://trafodion.apache.org/docs/client_install/index.html[Trafodion Client Installation Guide]) to validate your installation.
+{docs-url}/client_install/index.html[{project-name} Client Installation Guide]) to validate your installation.
=== Smoke Test
-A simple smoke test to validate that Trafodion is functioning.
+A simple smoke test to validate that {project-name} is functioning.
```
get schemas;
@@ -126,9 +126,9 @@ $
<<<
Assuming no errors, your installation has been successful. Next, do the following:
-* Install the Trafodion client software. Refer to the http://trafodion.apache.org/docs/client_install/index.html[Trafodion Client Installation Guide].
-* Use Trafodion. Refer to the http://trafodion.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual.]
-* Review other Trafodion documentation. Refer to the http://trafodion.apache.org/documentation.html[Trafodion documentation].
+* Install the {project-name} client software. Refer to the {docs-url}/client_install/index.html[{project-name} Client Installation Guide].
+* Use {project-name}. Refer to the {docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual.]
+* Review other {project-name} documentation. Refer to the http://trafodion.apache.org/documentation.html[{project-name} documentation].
[[activate-troubleshooting-tips]]
== Troubleshooting Tips
@@ -139,9 +139,9 @@ If you are not able to start up the environment or if there are problems running
If processes are not running as expected, then:
-* `sqstop` to shut down Trafodion. If some Trafodion processes do not terminate cleanly, then run `ckillall`.
-* `sqstart` to restart Trafodion.
+* `sqstop` to shut down {project-name}. If some {project-name} processes do not terminate cleanly, then run `ckillall`.
+* `sqstart` to restart {project-name}.
If problems persist please review logs:
-* `$MY_SQROOT/logs`: Trafodion logs.
+* `$MY_SQROOT/logs`: {project-name} logs.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc
index 752e025..f46d825 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc
@@ -20,27 +20,27 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[enable-security]]
= Enable Security
-If you do not enable security in Trafodion, then a client interface to Trafodion may request a user name and password,
-but Trafodion ignores the user name and password entered in the client interface, and the session runs as the database *root* user,
+If you do not enable security in {project-name}, then a client interface to {project-name} may request a user name and password,
+but {project-name} ignores the user name and password entered in the client interface, and the session runs as the database *root* user,
`DB__ROOT`, without restrictions. If you want to restrict users, restrict access to certain users only, or restrict access to an
object or operation, then you must enable security, which enforces authentication and authorization. You can enable security
-during installation by answering the Trafodion Installer's prompts or after installation by running the `traf_authentication_setup`
+during installation by answering the {project-name} Installer's prompts or after installation by running the `traf_authentication_setup`
script, which enables both authentication and authorization. For more information, see
<<enable-security-authentication-setup-script,Authentication Setup Script>> below.
-Trafodion does not manage user names and passwords internally but does support authentication via directory servers that support
-the OpenLDAP protocol, also known as LDAP servers. You can configure the LDAP servers during installation by answering the Trafodion
+{project-name} does not manage user names and passwords internally but does support authentication via directory servers that support
+the OpenLDAP protocol, also known as LDAP servers. You can configure the LDAP servers during installation by answering the {project-name}
Installer's prompts, or you can configure the LDAP servers manually after installation. For more information, please refer to
<<enable-security-configuring-ldap-servers,Configuring LDAP Servers>> below.
-Once authentication and authorization are enabled, Trafodion allows users to be registered in the database and allows privileges
-on objects to be granted to users and roles (which are granted to users). Trafodion also supports component-level (or system-level)
+Once authentication and authorization are enabled, {project-name} allows users to be registered in the database and allows privileges
+on objects to be granted to users and roles (which are granted to users). {project-name} also supports component-level (or system-level)
privileges, such as MANAGE_USERS, which can be granted to users and roles. Refer to <<enable-security-manage-users,Manage Users>> below.
[[enable-security-configuring-ldap-servers]]
@@ -68,14 +68,14 @@ If `Attribute1` has only one instance, `valueC` is used, otherwise, `valueA` and
Attributes are grouped into sections; this is for future enhancements. Attributes are declared in the `LOCAL` section, unless otherwise specified.
NOTE: Section names, attribute names, and the general layout of the authentication configuration file are subject to change in future versions
-of Trafodion and backward compatibility is not guaranteed.
+of {project-name} and backward compatibility is not guaranteed.
Specification of your directory server(s) requires at a minimum:
[cols="15%h,55%,30%a",options="header"]
|===
| Setting | Description | Example
-| LDAP Host Name(s) | One or more names of hosts that support the OpenLDAP protocol must be specified. Trafodion attempts to connect to all
+| LDAP Host Name(s) | One or more names of hosts that support the OpenLDAP protocol must be specified. {project-name} attempts to connect to all
provided host names during the authentication process. The set of user names and passwords should be identical on all hosts to avoid unpredictable
results. The attribute name is `LDAPHostName`. | `LDAPHostName: ldap.company.com`
| LDAP Port Number | Port number of the LDAP server. Typically this is 389 for servers using no encryption or TLS, and 636 for servers using SSL.
@@ -88,7 +88,7 @@ identifier specifiers. | `UniqueIdentifier: uid=,ou=users,dc=com`
• 1: SSL +
• 2: TLS | `LDAPSSL: 2` +
+
-If your LDAP server uses TLS you must specify a file containing the certificate used to encrypt the password. By default the Trafodion software
+If your LDAP server uses TLS you must specify a file containing the certificate used to encrypt the password. By default the {project-name} software
looks for this file in `$MY_SQROOT/cacerts`, but you may specify a fully qualified filename, or set the environment variable `CACERTS_DIR` to another
directory. To specify the file containing the certificate, you set the value of the attribute `TLS_CACERTFilename`, located in the Defaults section. +
+
@@ -102,10 +102,10 @@ has that requirement, provide these "search" values. | `LDAPSearchDN: lookup@com
`LDAPSearchPwd: Lookup123`
|===
-There are additional optional attributes that can be used to customize Trafodion authentication. As mentioned earlier, they are described in
+There are additional optional attributes that can be used to customize {project-name} authentication. As mentioned earlier, they are described in
<<enable-security-traf-authentication-config,.traf_authentication_config>> below.
-You can test the authentication configuration file for syntactic errors using the `ldapconfigcheck` tool. If you have loaded the Trafodion
+You can test the authentication configuration file for syntactic errors using the `ldapconfigcheck` tool. If you have loaded the {project-name}
environment (`sqenv.sh`), then the tool automatically checks the file at `$MY_SQROOT/sql/scripts/.traf_authentication_config`.
If not, you can specify the file to be checked.
@@ -122,8 +122,8 @@ Please refer to <<enable-security-ldapconfigcheck,ldapconfigcheck>> below for mo
NOTE: The authentication configuration file needs to be propagated to all nodes, but there is a script that does that for you described later.
For now, you can test your changes on the local node.
-You can test the LDAP connection using the utility `ldapcheck`. To use this utility the Trafodion environment must be loaded (`sqenv.sh`),
-but the Trafodion instance does not need to be running. To test the connection only, you can specify any user name, and a name lookup is performed
+You can test the LDAP connection using the utility `ldapcheck`. To use this utility the {project-name} environment must be loaded (`sqenv.sh`),
+but the {project-name} instance does not need to be running. To test the connection only, you can specify any user name, and a name lookup is performed
using the attributes in `.traf_authentication_config`.
```
@@ -146,10 +146,10 @@ Authentication successful
<<<
[[enable-security-generate-trafodion-certificate]]
-== Generate Trafodion Certificate
-Trafodion clients such as `trafci` encrypt the password before sending it to Trafodion. A self-signed certificate is used to encrypt the password.
+== Generate {project-name} Certificate
+{project-name} clients such as `trafci` encrypt the password before sending it to {project-name}. A self-signed certificate is used to encrypt the password.
The certificate and key should be generated when the `sqgen` script is invoked. By default, the files `server.key` and `server.crt` are located
-in `$HOME/sqcert`. If those files are not present and since Trafodion clients does not send unencrypted passwords, then you need to manually generate
+in `$HOME/sqcert`. If those files are not present and since {project-name} clients does not send unencrypted passwords, then you need to manually generate
those files. To do so, run the script `sqcertgen` located in `$MY_SQROOT/sql/scripts`. The script runs `openssl` to generate the certificate and key.
To run openssl manually, follow the example:
@@ -174,18 +174,18 @@ If you encrypt the private key, then you must enter the password every time the
|===
Both the public (`server.crt`) and private (`server.key`) files should be placed in the directory `$HOME/sqcert`. If you do not want to use
-the `HOME` directory or if you want to use different names for the private and/or public key files, then Trafodion supports environment variables
+the `HOME` directory or if you want to use different names for the private and/or public key files, then {project-name} supports environment variables
to specific the alternate locations or names.
-* Trafodion first checks the environment variables `SQCERT_PRIVKEY` and `SQCERT_PUBKEY`. If they are set, Trafodion uses the fully qualified filename
+* {project-name} first checks the environment variables `SQCERT_PRIVKEY` and `SQCERT_PUBKEY`. If they are set, {project-name} uses the fully qualified filename
value of the environment variable.
+
You can specify either one filename environment variable or both.
-* If at least one filename environment variable is not set, Trafodion checks the value of the environment variable `SQCERT_DIR`. If set,
+* If at least one filename environment variable is not set, {project-name} checks the value of the environment variable `SQCERT_DIR`. If set,
then the default filename `server.key` or `server.crt` is appended to the value of the environment variable `SQCERT_DIR`.
* If the filename environment variable is not set and the directory environment variable is not set,
-then Trafodion uses the default location (`$HOME/sqcert`) and the default filename.
+then {project-name} uses the default location (`$HOME/sqcert`) and the default filename.
[[enable-security-authentication-setup-script]]
== Authentication Setup Script
@@ -220,14 +220,14 @@ and propagates `sqenvcom.sh` and `.traf_authentication_config` to all nodes in t
The last step is to enable authorization by creating privilege-related metadata tables and set up default permissions with a call to the database.
The list of privilege-related metadata tables, users, roles, and component privileges are logged in `$MY_SQROOT/logs/authEnable.log`. +
+
-Specifying `--on` requires that a valid `.traf_authentication_config` file exists and the Trafodion metadata initialized.
+Specifying `--on` requires that a valid `.traf_authentication_config` file exists and the {project-name} metadata initialized.
| --off | If specified, then `traf_authentication_setup` sets the environment variable `TRAFODION_ENABLE_AUTHENTICATION` to `NO` in
`$MY_SQROOT/sqenvcom.sh` and propagates the file to all the nodes in the cluster. +
+
The last step is to disable authorization by removing any privilege-related metadata and permissions with a call to the database.
The results of this operation is logged in `$MY_SQROOT/logs/authEnable.log`.
-| --setup | Use this option if the Trafodion metadata has not been initialized. This option enables authentication but does not call the database
-to create privilege-related metadata tables. Later, when Trafodion metadata is initialized, privilege-related metadata tables and default permissions
+| --setup | Use this option if the {project-name} metadata has not been initialized. This option enables authentication but does not call the database
+to create privilege-related metadata tables. Later, when {project-name} metadata is initialized, privilege-related metadata tables and default permissions
are automatically created.
| --status | Reports the value of the environment variable `TRAFODION_ENABLE_AUTHENTICATION` in `$MY_SQROOT/sqenvcom.sh` on the current node and
reports the status of security features in the database.
@@ -266,7 +266,7 @@ ALTER USER DB__ROOT SET EXTERNAL NAME trafodion_rootuser_in_ldap;
```
To learn more about how to register users, grant object and component privileges, and manage users and roles, please see the
-http://trafodion.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual].
+{docs-url}/sql_reference/index.html[Trafodion SQL Reference Manual].
[[enable-security-traf-authentication-config]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
index 89e99e6..6df64fd 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
@@ -20,52 +20,52 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[introduction]]
= Introduction
-Trafodion is a Hadoop add-on service that provides transactional SQL on top of HBase. Typically, you
-use Trafodion as the database for applications that require Online Transaction Processing (OLTP),
-Operational Data Store (ODS), and/or strong reporting capabilities. You access Trafodion using
+{project-name} is a Hadoop add-on service that provides transactional SQL on top of HBase. Typically, you
+use {project-name} as the database for applications that require Online Transaction Processing (OLTP),
+Operational Data Store (ODS), and/or strong reporting capabilities. You access {project-name} using
standard JDBC and ODBC APIs.
-You may choose whether to add Trafodion to an existing Hadoop environment or to create a standalone
+You may choose whether to add {project-name} to an existing Hadoop environment or to create a standalone
Hadoop environment specifically for Hadoop.
-This guide assumes that a Hadoop environment exists upon which your provisioning Trafodion. Refer to
+This guide assumes that a Hadoop environment exists upon which your provisioning {project-name}. Refer to
<<requirements-hadoop-software,Hadoop Software>> for information about what Hadoop software is required
-Trafodion.
+{project-name}.
[[introduction-security-considerations]]
== Security Considerations
-The following users need be considered for Trafodion:
+The following users need be considered for {project-name}:
-* *Provisioning User*: A Linux-level user that performs the Trafodion provisioning tasks. This user ID
-requires `sudo` access and passwordless ssh among the nodes where Trafodion is installed. In addition,
+* *Provisioning User*: A Linux-level user that performs the {project-name} provisioning tasks. This user ID
+requires `sudo` access and passwordless ssh among the nodes where {project-name} is installed. In addition,
this user ID requires access to Hadoop distribution, HDFS, and HBase administrative users to change
-respective environment's configuration settings per Trafodion requirements. Refer to
-<<requirements-trafodion-provisioning-user,Trafodion Provisioning User>> for more information
+respective environment's configuration settings per {project-name} requirements. Refer to
+<<requirements-trafodion-provisioning-user,{project-name} Provisioning User>> for more information
about the requirements and usage associated with this user ID.
-* *Runtime User*: A Linux-level user under which the Trafodion software runs. This user ID must be registered
+* *Runtime User*: A Linux-level user under which the {project-name} software runs. This user ID must be registered
as a user in the Hadoop Distributed File System (HDFS) to store and access objects in HDFS, HBase, and Hive.
-In addition, this user ID requires passwordless access among the nodes where Trafodion is installed.
-Refer to <<requirements-trafodion-runtime-user,Trafodion Runtime User>> for more information about this user ID.
+In addition, this user ID requires passwordless access among the nodes where {project-name} is installed.
+Refer to <<requirements-trafodion-runtime-user,{project-name} Runtime User>> for more information about this user ID.
-* *Trafodion Database Users*: Trafodion users are managed by the Trafodion security features (grant, revoke, etc.),
+* *{project-name} Database Users*: {project-name} users are managed by the {project-name} security features (grant, revoke, etc.),
which can be integrated with LDAP if so desired. These users are referred to as *database users* and
do not have direct access to the operating system. Refer to
-http://trafodion.apache.org/docs/sql_reference/index.html#register_user_statement[Register User],
-http://trafodion.apache.org/docs/sql_reference/index.html#grant_statement[Grant], and other SQL statements
-in the http://trafodion.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual] for
-more information about managing Trafodion Database Users.
+{docs-url}/sql_reference/index.html#register_user_statement[Register User],
+{docs-url}/sql_reference/index.html#grant_statement[Grant], and other SQL statements
+in the {docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual] for
+more information about managing {project-name} Database Users.
+
+
-Optionally, you can enable Trafodion Security. If you do not enable security in Trafodion, then a client interface
-to Trafodion may request a user name and password, but Trafodion ignores the user name and password entered in the
+Optionally, you can enable {project-name} Security. If you do not enable security in {project-name}, then a client interface
+to {project-name} may request a user name and password, but {project-name} ignores the user name and password entered in the
client interface, and the session runs as the database *root* user, `DB__ROOT`, without restrictions. If you want
to restrict users, restrict access to certain users only, or restrict access to an object or operation, then you must
enable security, which enforces authentication and authorization. Refer to
@@ -74,71 +74,71 @@ enable security, which enforces authentication and authorization. Refer to
[[introduction-provisioning-options]]
== Provisioning Options
-Trafodion ships with a set of scripts (the Trafodion Installer) that takes care of many of the installation and upgrade
-tasks associated with the Trafodion software and its requirements. There is a separate set of scripts to remove Trafodion,
+{project-name} ships with a set of scripts (the {project-name} Installer) that takes care of many of the installation and upgrade
+tasks associated with the {project-name} software and its requirements. There is a separate set of scripts to remove {project-name},
if needed.
-Currently, the Trafodion Installer is able to install Trafodion on select Cloudera and Hortonworks Hadoop distributions only.
-The Trafodion Installer limitations are noted as they apply in the different chapters below. For example, the Trafodion Installer
-is less capable on SUSE than it is on RedHat/CentOS; you have to install the prerequisite software packages outside the Trafodion Installer.
+Currently, the {project-name} Installer is able to install {project-name} on select Cloudera and Hortonworks Hadoop distributions only.
+The {project-name} Installer limitations are noted as they apply in the different chapters below. For example, the {project-name} Installer
+is less capable on SUSE than it is on RedHat/CentOS; you have to install the prerequisite software packages outside the {project-name} Installer.
-The Trafodion Installer automates many of the tasks required to install/upgrade Trafodion, spanning from downloading and
+The {project-name} Installer automates many of the tasks required to install/upgrade {project-name}, spanning from downloading and
installing required software packages and making required changes to your Hadoop environment via creating
-the Trafodion runtime user ID to installing and starting Trafodion. It is, therefore, highly recommend that
-you use the Trafodion Installer for initial installation and upgrades of Trafodion. These steps are referred to as
-"Script-Based Provisioning" in this guide. Refer to <<introduction-trafodion-installer, Trafodion Installer>> provides
+the {project-name} runtime user ID to installing and starting {project-name}. It is, therefore, highly recommend that
+you use the {project-name} Installer for initial installation and upgrades of {project-name}. These steps are referred to as
+"Script-Based Provisioning" in this guide. Refer to <<introduction-trafodion-installer, {project-name} Installer>> provides
usage information.
-If, for any reason, you choose not to use the Trafodion Installer, then separate chapters provide
-step-by-step recipes for the tasks required to install/upgrade Trafodion. These steps are referred to as
+If, for any reason, you choose not to use the {project-name} Installer, then separate chapters provide
+step-by-step recipes for the tasks required to install/upgrade {project-name}. These steps are referred to as
*Recipe-Based Provisioning* in this guide. It is assumed that you are well-versed in Linux and Hadoop
administrative tasks if using Recipe-Based Provisioning.
[[introduction-provisioning-activities]]
== Provisioning Activities
-Trafodion provisioning is divided into the following main activities:
+{project-name} provisioning is divided into the following main activities:
-* *<<requirements,Requirements>>*: Activities and documentation required to install the Trafodion software.
+* *<<requirements,Requirements>>*: Activities and documentation required to install the {project-name} software.
These activities include tasks such as understanding hardware and operating system requirements,
Hadoop requirements, what software packages that need to be downloaded, configuration settings that need to be changed,
user IDs requirements, and so on.
* *<<prepare,Prepare>>*: Activities to prepare the operating system and the Hadoop ecosystem to run
-Trafodion. These activities include tasks such as installing required software packages, configure
-the Trafodion Installation User, gather information about the Hadoop environment, modify configuration
+{project-name}. These activities include tasks such as installing required software packages, configure
+the {project-name} Installation User, gather information about the Hadoop environment, modify configuration
for different Hadoop services, and so forth.
-* *<<install,Install>>*: Activities related to installing the Trafodion software. These activities
-include tasks such as unpacking the Trafodion tar files, creating the Trafodion Runtime User,
-creating Trafodion HDFS directories, installing the Trafodion software, and so forth.
+* *<<install,Install>>*: Activities related to installing the {project-name} software. These activities
+include tasks such as unpacking the {project-name} tar files, creating the {project-name} Runtime User,
+creating {project-name} HDFS directories, installing the {project-name} software, and so forth.
<<<
-* *<<upgrade,Upgrade>>*: Activities related to the upgrading the Trafodion software. These activities
-include tasks such as shutting down Trafodion, installing a new version of the Trafodion software,
+* *<<upgrade,Upgrade>>*: Activities related to the upgrading the {project-name} software. These activities
+include tasks such as shutting down {project-name}, installing a new version of the {project-name} software,
and so on. The upgrade tasks vary depending on the differences between the current and new release of
-Trafodion. For example, an upgrade may or may not include an upgrade of the Trafodion metadata.
+{project-name}. For example, an upgrade may or may not include an upgrade of the {project-name} metadata.
-* *<<activate,Activate>>*: Activities related to starting the Trafodion software. These actives
-include basic management tasks such as starting and checking the status of the Trafodion components,
+* *<<activate,Activate>>*: Activities related to starting the {project-name} software. These actives
+include basic management tasks such as starting and checking the status of the {project-name} components,
performing basic smoke tests, and so forth.
-* *<<remove,Remove>>*: Activities related to removing Trafodion from your Hadoop cluster.
+* *<<remove,Remove>>*: Activities related to removing {project-name} from your Hadoop cluster.
[[introduction-provisioning-master-node]]
== Provisioning Master Node
All provisioning tasks are performed from a single node in the cluster, which must be part
-of the Hadoop environment you're adding Trafodion to. This node is referred to as the
+of the Hadoop environment you're adding {project-name} to. This node is referred to as the
"*Provisioning Master Node*" in this guide.
-The Trafodion Provisioning User must have access to all other nodes from the Provisioning
+The {project-name} Provisioning User must have access to all other nodes from the Provisioning
Master Node in order to perform provisioning tasks on the cluster.
[[introduction-trafodion-installer]]
-== Trafodion Installer
+== {project-name} Installer
-The Trafodion Installer is a set of scripts automates most of the tasks requires to install/upgrade Trafodion.
-You download the Trafodion Installer tar file from the Trafodion http://trafodion.apache.org/download.html[download] page.
+The {project-name} Installer is a set of scripts automates most of the tasks requires to install/upgrade {project-name}.
+You download the {project-name} Installer tar file from the {project-name} {download-url}[download] page.
Next, you unpack the tar file.
*Example*
@@ -157,11 +157,11 @@ $
```
<<<
-The Trafodion Installer supports two different modes:
+The {project-name} Installer supports two different modes:
1. *Guided Setup*: Prompts for information as it works through the installation/upgrade process. This mode is recommended for new users.
2. *Automated Setup*: Required information is provided in a pre-formatted bash-script configuration file, which is provided
-via a command argument when running the Trafodion Installer thereby suppressing all prompts.
+via a command argument when running the {project-name} Installer thereby suppressing all prompts.
+
A template of the configuration file is available here within the installer directory: `trafodion_config_default`.
Make a copy of the file in your directory and populate the needed information.
@@ -173,22 +173,22 @@ populate this file.
[[introduction-trafodion-installer-usage]]
=== Usage
-The following shows help for the Trafodion Installer.
+The following shows help for the {project-name} Installer.
```
./trafodion_install --help
-This script will install Trafodion. It will create a configuration
+This script will install {project-name}. It will create a configuration
file (if one has not been created), setup of the environment needed
-for Trafodion, configure HBase with Hbase-trx and co-processors needed,
-and install a specified Trafodion build.
+for {project-name}, configure HBase with Hbase-trx and co-processors needed,
+and install a specified {project-name} build.
Options:
--help Print this message and exit
--accept_license If provided, the user agrees to accept all the
- provisions in the Trafodion license. This allows
+ provisions in the {project-name} license. This allows
for automation by skipping the display and prompt of
- the Trafodion license.
+ the {project-name} license.
--config_file If provided, all install prompts will be
taken from this file and not prompted for.
```
@@ -197,17 +197,17 @@ Options:
[[introduction-trafodion-installer-install-vs-upgrade]]
=== Install vs. Upgrade
-The Trafodion Installer automatically detects whether you're performing an install
-or an upgrade by looking for the Trafodion Runtime User in the `/etc/passwd` file.
+The {project-name} Installer automatically detects whether you're performing an install
+or an upgrade by looking for the {project-name} Runtime User in the `/etc/passwd` file.
-* If the user ID doesn't exist, then the Trafodion Installer runs in install mode.
-* If the user ID exists, then the Trafodion Installer runs in upgrade mode.
+* If the user ID doesn't exist, then the {project-name} Installer runs in install mode.
+* If the user ID exists, then the {project-name} Installer runs in upgrade mode.
[[introduction-trafodion-installer-guided-setup]]
=== Guided Setup
-By default, the Trafodion Installer runs in Guided Setup mode, which means
+By default, the {project-name} Installer runs in Guided Setup mode, which means
that it prompts you for information during the install/upgrade process.
Refer to the following sections for examples:
@@ -218,9 +218,9 @@ Refer to the following sections for examples:
[[introduction-trafodion-installer-automated-setup]]
=== Automated Setup
-The `--config_file` option runs the Trafodion in Automated Setup mode.
+The `--config_file` option runs the {project-name} in Automated Setup mode.
-Before running the Trafodion Installer with this option, you do the following:
+Before running the {project-name} Installer with this option, you do the following:
1. Copy the `trafodion_config_default` file.
+
@@ -234,7 +234,7 @@ cp trafodion_config_default my_config
<<prepare-gather-configuration-information,Gather Configuration Information>>
section in the <<prepare,Prepare>> chapter.
-3. Run the Trafodion Installer in Automated Setup Mode
+3. Run the {project-name} Installer in Automated Setup Mode
+
*Example*
+
@@ -242,11 +242,11 @@ section in the <<prepare,Prepare>> chapter.
./trafodion_installer --config_file my_config
```
-NOTE: Your Trafodion Configuration File contains the password for the Trafodion Runtime User
+NOTE: Your {project-name} Configuration File contains the password for the {project-name} Runtime User
and for the Distribution Manager. Therefore, we recommend that you secure the file in a manner
that matches the security policies of your organization.
-==== Example: Creating a Trafodion Configuration File
+==== Example: Creating a {project-name} Configuration File
Using the instructions in <<prepare-gather-configuration-information,Gather Configuration Information>>
in the <<prepare,Prepare>> chapter, you record the following information.
@@ -256,8 +256,8 @@ in the <<prepare,Prepare>> chapter, you record the following information.
| ID | Information | Setting
| ADMIN | Administrator user name for Apache Ambari or Cloudera Manager. | admin
| BACKUP_DCS_NODES | List of nodes where to start the backup DCS Master components. |
-| CLOUD_CONFIG | Whether you're installing Trafodion on a cloud environment. | N
-| CLOUD_TYPE | What type of cloud environment you're installing Trafodion on. |
+| CLOUD_CONFIG | Whether you're installing {project-name} on a cloud environment. | N
+| CLOUD_TYPE | What type of cloud environment you're installing {project-name} on. |
| CLUSTER_NAME | The name of the Hadoop Cluster. | Cluster 1
| DCS_BUILD | Tar file containing the DCS component. |
| DCS_PRIMARY_MASTER_NODE | The node where the primary DCS should run. |
@@ -265,12 +265,12 @@ in the <<prepare,Prepare>> chapter, you record the following information.
| ENABLE_HA | Whether to run DCS in high-availability (HA) mode. | N
| EPEL_RPM | Location of EPEL RPM. Specify if you don't have access to the Internet. |
| FLOATING_IP | IP address if running DCS in HA mode. |
-| HADOOP_TYPE | The type of Hadoop distribution you're installing Trafodion on. | cloudera
+| HADOOP_TYPE | The type of Hadoop distribution you're installing {project-name} on. | cloudera
| HBASE_GROUP | Linux group name for the HBASE administrative user. | hbase
| HBASE_USER | Linux user name for the HBASE administrative user. | hbase
| HDFS_USER | Linux user name for the HDFS administrative user. | hdfs
| HOME_DIR | Root directory under which the `trafodion` home directory should be created. | /home
-| INIT_TRAFODION | Whether to automatically initialize the Trafodion database. | Y
+| INIT_TRAFODION | Whether to automatically initialize the {project-name} database. | Y
| INTERFACE | Interface type used for $FLOATING_IP. |
| JAVA_HOME | Location of Java 1.7.0_65 or higher (JDK). | /usr/java/jdk1.7.0_67-cloudera
| LDAP_CERT | Full path to TLS certificate. |
@@ -281,17 +281,17 @@ in the <<prepare,Prepare>> chapter, you record the following information.
| LDAP_PORT | Port used to communicate with LDAP Identity Store. |
| LDAP_SECURITY | Whether to enable simple LDAP authentication. | N
| LDAP_USER | LDAP Search user name. |
-| LOCAL_WORKDIR | The directory where the Trafodion Installer is located. | /home/centos/trafodion-installer/installer
+| LOCAL_WORKDIR | The directory where the {project-name} Installer is located. | /home/centos/trafodion-installer/installer
| MANAGEMENT_ENABLED | Whether your installation uses separate management nodes. | N
| MANAGEMENT_NODES | The FQDN names of management nodes, if any. |
-| NODE_LIST | The FQDN names of the nodes where Trafodion will be installed. | trafodion-1 trafodion-2
+| NODE_LIST | The FQDN names of the nodes where {project-name} will be installed. | trafodion-1 trafodion-2
| PASSWORD | Administrator password for Apache Ambari or Cloudera Manager. | admin
| REST_BUILD | Tar file containing the REST component. |
-| SQ_ROOT | Target directory for the Trafodion software. | /home/trafodion/apache-trafodion-1.3.0-incubating-bin
-| START | Whether to start Trafodion after install/upgrade. | Y
-| SUSE_LINUX | Whether your installing Trafodion on SUSE Linux. | false
-| TRAF_PACKAGE | The location of the Trafodion installation package tar file or core installation tar file. | /home/centos/trafodion-download/apache-trafodion-1.3.0-incubating-bin.tar.gz
-| TRAF_USER | The Trafodion runtime user ID. Must be `trafodion` in this release. | trafodion
+| SQ_ROOT | Target directory for the {project-name} software. | /home/trafodion/apache-trafodion-1.3.0-incubating-bin
+| START | Whether to start {project-name} after install/upgrade. | Y
+| SUSE_LINUX | Whether your installing {project-name} on SUSE Linux. | false
+| TRAF_PACKAGE | The location of the {project-name} installation package tar file or core installation tar file. | /home/centos/trafodion-download/apache-trafodion-1.3.0-incubating-bin.tar.gz
+| TRAF_USER | The {project-name} runtime user ID. Must be `trafodion` in this release. | trafodion
| TRAF_USER_PASSWORD | The password used for the `trafodion:trafodion` user ID. | traf123
| URL | FQDN and port for the Distribution Manager's REST API. | trafodion-1.apache.org:7180
|===
@@ -322,13 +322,13 @@ Next, you edit `my_config` to contain the following:
# @@@ END COPYRIGHT @@@
#====================================================
-# Trafodion Configuration File
+# {project-name} Configuration File
# This file contains default values for the installer.
# Users can also edit this file and provide values for all parameters
# and then specify this file on the run line of trafodion_install.
# Example:
-# ./trafodion_install --config_file <Trafodion-config-file>
+# ./trafodion_install --config_file <{project-name}-config-file>
# WARNING: This mode is for advanced users!
#
#=====================================================
@@ -340,7 +340,7 @@ Next, you edit `my_config` to contain the following:
export SUSE_LINUX="false"
-# The working directory where Trafodion installer untars files, etc.
+# The working directory where {project-name} installer untars files, etc.
# do not change this unless you really know what you are doing
export TRAF_WORKDIR="/usr/lib/trafodion"
@@ -353,10 +353,10 @@ export DCS_SERVERS_PARM="8"
# "true" if this is an upgrade
export UPGRADE_TRAF="false"
-# Trafodion userid, This is the userid the Trafodion instance will run under
+# {project-name} userid, This is the userid the {project-name} instance will run under
export TRAF_USER="trafodion"
-# Trafodion userid's password
+# {project-name} userid's password
export TRAF_USER_PASSWORD="traf123"
# a blank separated list of nodes in your cluster
@@ -384,7 +384,7 @@ export JAVA_HOME="/usr/java/jdk1.7.0_67-cloudera"
# will be installed from the internet
export EPEL_RPM=""
-# full path of the Trafodion package tar file
+# full path of the {project-name} package tar file
export TRAF_PACKAGE="/home/centos/trafodion-download/apache-trafodion-1.3.0-incubating-bin.tar.gz"
# if TRAF_PACKAGE wasn't specified then these two values must be specified
@@ -397,7 +397,7 @@ export REST_BUILD=""
# Either "cloudera" or "hortonworks" (all lowercase)
export HADOOP_TYPE="cloudera"
-# The URL for Cloudera/Hortonworks REST API (i.e. node1.hp.com:8080)
+# The URL for Cloudera/Hortonworks REST API (i.e. node1.host.com:8080)
export URL="trafodion-1.apache.org:7180"
# Cloudera/Hortonworks UI admin's userid and password
@@ -417,7 +417,7 @@ export HBASE_GROUP="hbase"
# The hadoop HBase service name
export HBASE="hbase"
-# full path of where to install Trafodion to
+# full path of where to install {project-name} to
# Example is used below. If $HOME_DIR or $TRAF_USER have been changed
# then this will need to be changed.
# On an upgrade, it is recommend to choose a different directory.
@@ -426,7 +426,7 @@ export HBASE="hbase"
# By doing this the previous version will remain and allow for an easier rollback.
export SQ_ROOT="/home/trafodion/apache-trafodion-1.3.0-incubating-bin"
-# Start Trafodion after install completes
+# Start {project-name} after install completes
export START="Y"
# initialize trafodion after starting
@@ -445,7 +445,7 @@ export LDAP_SECURITY="N"
export LDAP_AUTH_FILE="traf_authentication_config_${HOSTNAME}"
```
-Once completed, run the Trafodion Installer with the `--config_file` option.
+Once completed, run the {project-name} Installer with the `--config_file` option.
Refer to the following sections for examples:
@@ -453,9 +453,9 @@ Refer to the following sections for examples:
* <<upgrade-automated-upgrade, Automated Upgrade>>
[[introduction-trafodion-provisioning-directories]]
-== Trafodion Provisioning Directories
+== {project-name} Provisioning Directories
-Trafodion stores its provisioning information in the following directories on each node in the cluster:
+{project-name} stores its provisioning information in the following directories on each node in the cluster:
* `/etc/trafodion`: Configurtion information.
* `/usr/lib/trafodion`: Copies of the installer files.
[14/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
Posted by db...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/ddl_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/ddl_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/ddl_msgs.adoc
index 0b9e951..48aee43 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/ddl_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/ddl_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[data-definition-language-messages]]
@@ -70,7 +70,7 @@ specified a schema that does not exist.
Table, view, or stored procedure <object-name> does not exist or object type is invalid for the current operation.
```
-Where <object-name> is the name of a Trafodion database object.
+Where <object-name> is the name of a {project-name} database object.
*Cause:* You attempted an operation on an object that does not exist.
@@ -107,7 +107,7 @@ of the constraints that exist on a table.
Index <index-name> does not exist.
```
-Where <index-name> is a Trafodion database object name.
+Where <index-name> is a {project-name} database object name.
*Cause:* The operation you attempted requires the existence of an index
named <index-name>.
@@ -125,11 +125,11 @@ correct qualified name.
User name <user-name> does not exist.
```
-Where <user-name> is a Trafodion platform user name.
+Where <user-name> is a {project-name} platform user name.
*Cause:* The user name specified in a GRANT or REVOKE statement, or the
authorization ID in a CREATE SCHEMA statement, does not represent a
-valid Trafodion platform user.
+valid {project-name} platform user.
*Effect:* The operation fails.
@@ -164,7 +164,7 @@ The statement just specified is currently not supported.
*Effect:* The operation fails.
-*Recovery:* Do not attempt to use this Trafodion database statement.
+*Recovery:* Do not attempt to use this {project-name} database statement.
<<<
[[SQL-1012]]
@@ -191,7 +191,7 @@ Not all privileges were granted. You lack grant option on some of the specified
*Cause:* You attempted to grant privileges, but you do not have grant
options for at least one of them.
-*Effect:* The Trafodion database granted some privileges, but not all
+*Effect:* The {project-name} database granted some privileges, but not all
that you attempted to grant.
*Recovery:* You must have grant options for privileges to grant them.
@@ -211,7 +211,7 @@ then performs a grant to a third user, you cannot revoke privileges to
the second user until that user revokes their privileges to the third
user.
-*Effect:* The Trafodion database did not revoke the privileges.
+*Effect:* The {project-name} database did not revoke the privileges.
*Recovery:* Make sure that the dependent privileges from the user whose
privileges you want to revoke are revoked first.
@@ -226,7 +226,7 @@ Some of the specified privileges could not be revoked.
*Cause:* You attempted to revoke a privilege that does not exist or that
was granted by another user.
-*Effect:* The Trafodion database did not revoke the privileges.
+*Effect:* The {project-name} database did not revoke the privileges.
*Recovery:* The user who granted the privileges must revoke them.
@@ -275,7 +275,7 @@ Privilege settings on metadata tables cannot be changed.
*Cause:* You attempted to change privilege settings on a metadata table.
They cannot be changed.
-*Effect:* Trafodion does not change the settings.
+*Effect:* {project-name} does not change the settings.
*Recovery:* None.
@@ -289,7 +289,7 @@ SQL is already initialized on system <node-name>.
Where <node-name> is the name of the system on which the INITIALIZE SQL
statement was executed.
-*Cause:* The Trafodion database has already been initialized on this
+*Cause:* The {project-name} database has already been initialized on this
node.
*Effect:* No operation is performed.
@@ -304,7 +304,7 @@ node.
Schema <schema-name> already exists.
```
-Where <schema-name> is the name of a Trafodion database schema.
+Where <schema-name> is the name of a {project-name} database schema.
*Cause:* You attempted to create a schema in a catalog that already
contains a schema with that name.
@@ -362,7 +362,7 @@ Request failed. One or more dependent objects exist.
table. These objects cannot be dropped if they have dependent objects
and the drop-behavior is RESTRICT.
-*Effect:* Trafodion does not perform the
+*Effect:* {project-name} does not perform the
operation.
*Recovery:* For DROP statements that support the CASCADE drop-behavior,
@@ -414,7 +414,7 @@ its catalog.
The schema must be empty. It contains at least one object <object-name>.
```
-Where <object-name> is the name of a Trafodion database object existing
+Where <object-name> is the name of a {project-name} database object existing
in the schema.
*Cause:* You attempted to drop a schema that contains one or more
@@ -449,7 +449,7 @@ accompanying error messages to determine the cause.
File label <file-name> could not be accessed. File system error <error>.
```
-Where <file-name> is the name of a Trafodion database file.
+Where <file-name> is the name of a {project-name} database file.
Where <error> is a file system error number.
@@ -470,7 +470,7 @@ Where <object-name> is the SQL object.
*Cause:* See the accompanying error message for the cause.
-*Effect:* Trafodion does not drop the object.
+*Effect:* {project-name} does not drop the object.
*Recovery:* Apply the recovery of the accompanying error message.
@@ -482,7 +482,7 @@ Where <object-name> is the SQL object.
Catalog <catalog-name> already exists.
```
-Where <catalog-name> is the name of a Trafodion database catalog.
+Where <catalog-name> is the name of a {project-name} database catalog.
*Cause:* You attempted to create a catalog using the name of an already
existing catalog.
@@ -511,19 +511,19 @@ ID.
== SQL 1037
```
-Trafodion is not installed on system <node>.
+{project-name} is not installed on system <node>.
```
Where <node> is the name of the node referenced by the operation.
*Cause:* In a replication or distribution context: An operation
attempted to create a catalog reference or a partition on a node where
-the Trafodion database has not been installed.
+the {project-name} database has not been installed.
*Effect:* The operation fails.
*Recovery:* Either reissue the statement specifying a different node, or
-install the Trafodion database on <node> and resubmit.
+install the {project-name} database on <node> and resubmit.
[[SQL-1038]]
== SQL 1038
@@ -549,7 +549,7 @@ The DROP SQL statement could not be executed.
*Cause:* See the accompanying error message for the cause.
-*Effect:* Trafodion does not drop SQL.
+*Effect:* {project-name} does not drop SQL.
*Recovery:* Apply the recovery of the accompanying error message.
@@ -561,7 +561,7 @@ The use of ALTER on metadata tables is not permitted.
```
*Cause:* An ALTER TABLE statement was issued naming a table that is part
-of the Trafodion database metadata. Such tables cannot be altered.
+of the {project-name} database metadata. Such tables cannot be altered.
*Effect:* The operation fails.
@@ -649,7 +649,7 @@ that is declared as deferrable. This is an internal error.
*Effect:* The operation fails.
*Recovery:* Check that the referential constraint references a unique
-constraint that is not declared deferrable. Contact the Trafodion User
+constraint that is not declared deferrable. Contact the {project-name} User
Distribution List
[[SQL-1046]]
@@ -750,7 +750,7 @@ insufficient privileges.
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for the required
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for the required
security needed to create a view or trigger.
[[SQL-1053]]
@@ -776,7 +776,7 @@ statement.
== SQL 1057
```
-Trafodion objects cannot be created on <volume-name>: File system error <error-number>.
+{project-name} objects cannot be created on <volume-name>: File system error <error-number>.
```
Where <volume-name> is the name of a volume.
@@ -820,7 +820,7 @@ constraint.
*Cause:* You attempted to drop a table that has a referential constraint
or a check constraint that refers to another table.
-*Effect:* Trafodion does not drop the table.
+*Effect:* {project-name} does not drop the table.
*Recovery:* Either drop all constraints that refer to other tables and
then drop the table, or reissue the DROP TABLE statement, specifying the
@@ -833,9 +833,9 @@ CASCADE option.
Dropping metadata catalog <catalog-name> is not allowed.
```
-Where <catalog-name> is the name of a Trafodion database catalog.
+Where <catalog-name> is the name of a {project-name} database catalog.
-*Cause:* You attempted to drop a catalog that is part of the Trafodion
+*Cause:* You attempted to drop a catalog that is part of the {project-name}
database metadata.
*Effect:* The operation fails.
@@ -850,9 +850,9 @@ database metadata.
Dropping metadata schema <schema-name> is not allowed.
```
-Where <schema-name> is the name of a Trafodion database metadata schema.
+Where <schema-name> is the name of a {project-name} database metadata schema.
-*Cause:* You attempted to drop a schema that is part of the Trafodion
+*Cause:* You attempted to drop a schema that is part of the {project-name}
database metadata.
*Effect:* The operation fails.
@@ -866,10 +866,10 @@ database metadata.
Dropping metadata index <index-name> is not allowed.
```
-Where <index-name> is the name of a Trafodion database index.
+Where <index-name> is the name of a {project-name} database index.
*Cause:* An attempt was made to drop an index that is part of the
-Trafodion database metadata.
+{project-name} database metadata.
*Effect:* The operation fails.
@@ -883,7 +883,7 @@ Trafodion database metadata.
Dropping metadata view <table-name> is not allowed.
```
-Where <table-name> is the name of a Trafodion database table.
+Where <table-name> is the name of a {project-name} database table.
*Cause:* An attempt was made to drop a view that is a metadata object.
Metadata views and their creation are not currently supported, so this
@@ -933,7 +933,7 @@ not allowed.
Schema <schema-name> could not be dropped.
```
-Where <schema-name> is the name of a Trafodion database schema.
+Where <schema-name> is the name of a {project-name} database schema.
*Cause:* See the accompanying error message for the cause of the
problem.
@@ -951,7 +951,7 @@ message.
Object <object-name> could not be created. File error: <error-number>.
```
-Where <object-name> is the name of the Trafodion database object.
+Where <object-name> is the name of the {project-name} database object.
Where <error-number> is the file system error number.
@@ -969,9 +969,9 @@ system error <error-number>.
Object <ANSI-name> could not be accessed.
```
-Where <ANSI-name> is the name of the Trafodion database object.
+Where <ANSI-name> is the name of the {project-name} database object.
-*Cause:* The statement issued required access to the Trafodion platform
+*Cause:* The statement issued required access to the {project-name} platform
file underlying object <ANSI-name>.
*Effect:* The operation fails.
@@ -1006,7 +1006,7 @@ constraint that has not been disabled.
Only services ID can execute INITIALIZE SQL.
```
-*Cause:* You attempted to initialize the Trafodion database, but you are
+*Cause:* You attempted to initialize the {project-name} database, but you are
not the services ID. Only the services ID can perform this function.
*Effect:* The operation fails.
@@ -1029,7 +1029,7 @@ Where <schema-name> is the name of a schema in the specified catalog.
*Recovery:* Drop all schemas in the catalog and resubmit.
-*Recovery:* None. Contact the Trafodion User Distribution List
+*Recovery:* None. Contact the {project-name} User Distribution List
[[SQL-1078]]
== SQL 1078
@@ -1044,7 +1044,7 @@ Where <location-name> is a name specified in a LOCATION clause.
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for limitations on
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for limitations on
names allowed in the LOCATION clause. Correct the name and resubmit.
<<<
@@ -1052,7 +1052,7 @@ names allowed in the LOCATION clause. Correct the name and resubmit.
== SQL 1079
```
-Trafodion was not able to prepare the statement.
+{project-name} was not able to prepare the statement.
```
*Cause:* See the accompanying error message for the cause.
@@ -1072,7 +1072,7 @@ Where <column-name> is the name of a column of a table.
*Cause:* You attempted to create a table that has two columns with the
same name. If you name a column "SYSKEY," duplication can result from
-the implicit creation by the Trafodion database software of a column
+the implicit creation by the {project-name} database software of a column
named SYSKEY to ensure uniqueness for the clustering key.
*Effect:* The operation fails.
@@ -1437,7 +1437,7 @@ reissue the statement.
Metadata tables for catalog <catalog-name> could not be created on <location-info>.
```
-Where <catalog-name> is the name of a Trafodion database catalog.
+Where <catalog-name> is the name of a {project-name} database catalog.
Where <location-info> is the location where the tables could not be
created.
@@ -1526,10 +1526,10 @@ Where <table-name> is the name of the object.
Dropping metadata object <table-name> is not allowed.
```
-Where <table-name> is the name of a Trafodion database metadata table.
+Where <table-name> is the name of a {project-name} database metadata table.
*Cause:* You attempted to use the DROP TABLE statement to drop a table
-that is part of the Trafodion database metadata.
+that is part of the {project-name} database metadata.
*Effect:* The table is not dropped.
@@ -1781,7 +1781,7 @@ exceeds the maximum allowed row size.
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for row size limit
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for row size limit
calculations. Change the column definitions and reissue the statement.
<<<
@@ -1792,10 +1792,10 @@ calculations. Change the column definitions and reissue the statement.
Label <file-name> for object could not be accessed. File system error <error-number>.
```
-Where <file-name> is the Trafodion platform file name of a partition of
+Where <file-name> is the {project-name} platform file name of a partition of
object.
-Where <error-number> is a Trafodion platform file system error.
+Where <error-number> is a {project-name} platform file system error.
*Cause:* An ALTER TABLE or ALTER INDEX operation encountered a file
system error.
@@ -1813,10 +1813,10 @@ Because it is not audited, this table cannot have a column added that is declare
*Cause:* Internal error.
-*Effect:* The Trafodion database is unable to perform the requested
+*Effect:* The {project-name} database is unable to perform the requested
operation.
-*Recovery:* None. Contact the Trafodion User Distribution List
+*Recovery:* None. Contact the {project-name} User Distribution List
<<<
[[SQL-1143]]
@@ -1874,17 +1874,17 @@ compatible with the type of column <column-name> and resubmit.
== SQL 1145
```
-The catalog name <catalog-name> is reserved for Trafodion metadata.
+The catalog name <catalog-name> is reserved for {project-name} metadata.
```
-Where <catalog-name> is the name of a Trafodion database catalog.
+Where <catalog-name> is the name of a {project-name} database catalog.
-*Cause:* Trafodion reserves certain catalog names
+*Cause:* {project-name} reserves certain catalog names
for its own use.
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for reserved names.
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for reserved names.
Change <catalog-name> to a name that is not reserved and resubmit.
[[SQL-1146]]
@@ -1958,7 +1958,7 @@ Where <table-name> is the name of the table.
*Cause:* When the Partition Overlay Support feature is enabled without
setting volume names (through CQD POS_LOCATIONS) for table partitions to
reside on, location names are generated automatically. However, the
-Trafodion database software could not generate the location names
+{project-name} database software could not generate the location names
automatically and, because the CQD POS_RAISE_ERROR is set, the table is
not created.
@@ -1987,7 +1987,7 @@ Where <table-name> is the name of the table.
*Cause:* When the Partition Overlay Support feature is enabled without
setting volume names (through CQD POS_LOCATIONS) for table partitions to
reside on, location names are generated automatically. However, the
-Trafodion database software could not generate the location names
+{project-name} database software could not generate the location names
automatically, and because the CQD POS_RAISE_ERROR is not set, the given
table is created as a simple table without partitions as it would be if
the Partition Overlay Support feature was not enabled.
@@ -2009,7 +2009,7 @@ CONTROL QUERY DEFAULT POS_LOCATIONS, and then retry the request.
Cannot create object <object-name> as the table size is too big to fit on the system.
```
-*Cause:* Trafodion could not create the object
+*Cause:* {project-name} could not create the object
because the requested table size is bigger than the total amount of disk
space available on the system.
@@ -2115,7 +2115,7 @@ key, do not specify a STORE BY clause. Correct the syntax and resubmit.
System generated column SYSKEY cannot be specified as part of the PARTITION BY clause.
```
-*Cause:* Trafodion could not create the object
+*Cause:* {project-name} could not create the object
because system-generated column SYSKEY is not allowed as part of the
PARTITION BY clause.
@@ -2137,14 +2137,14 @@ Where <schema-name> is the schema in which the object is being created.
Where <directory-name> is the designated subvolume name for that schema.
*Cause:* One or more LOCATION clauses in the CREATE or MODIFY statement
-contained a Trafodion platform location whose subvolume did not match
+contained a {project-name} platform location whose subvolume did not match
the designated subvolume for the schema in which the object was being
created.
*Effect:* The object was not created.
*Recovery:* Either correct the invalid LOCATION clauses or remove them
-and allow the system to generate the Trafodion platform locations.
+and allow the system to generate the {project-name} platform locations.
[[SQL-1181]]
== SQL 1181
@@ -2163,7 +2163,7 @@ Where <error> is the returned file system error number.
*Effect:* The DDL DROP operation fails.
-*Recovery:* See previous messages in this Trafodion database software
+*Recovery:* See previous messages in this {project-name} database software
operation to determine the necessary corrective actions. Also, use the
file system error <error-number> to analyze the cause. For information
about file system errors, see <<file_system_errors, File-System Errors>>.
@@ -2265,17 +2265,17 @@ default to be compatible types and resubmit.
== SQL 1187
```
-The schema name <schema-name> is reserved for Trafodion metadata.
+The schema name <schema-name> is reserved for {project-name} metadata.
```
-Where <schema-name> is the name of a Trafodion database schema.
+Where <schema-name> is the name of a {project-name} database schema.
-*Cause:* Trafodion reserves certain schema names
+*Cause:* {project-name} reserves certain schema names
for its own use.
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for reserved schema
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for reserved schema
names. Choose a name that is not reserved and reissue the CREATE statement.
<<<
@@ -2313,7 +2313,7 @@ Where <parameter-name> is the name of the parameter.
*Cause:* You specified a data type for this routine parameter that is
not supported.
-*Effect:* Trafodion is unable to complete the operation.
+*Effect:* {project-name} is unable to complete the operation.
*Recovery:* Specify a different data type.
@@ -2395,10 +2395,10 @@ about file system errors, see <<file_system_errors,File-System Errors>>.
== SQL 1233
```
-Creating schema in Trafodion system catalog <catalog-name> is prohibited.
+Creating schema in {project-name} system catalog <catalog-name> is prohibited.
```
-Where <catalog-name> is the name of the Trafodion database catalog.
+Where <catalog-name> is the name of the {project-name} database catalog.
*Cause:* You attempted to create a schema in the system catalog.
@@ -2689,16 +2689,16 @@ DDL or utility operation.
== SQL 1263
```
-Table, view, and stored procedure names that start with <text> are reserved for Trafodion metadata.
+Table, view, and stored procedure names that start with <text> are reserved for {project-name} metadata.
```
Where <text> is the disallowed name that was specified.
-*Cause:* You specified a Trafodion database reserved object name.
+*Cause:* You specified a {project-name} database reserved object name.
*Effect:* The object is not created.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for the list of
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for the list of
reserved object names. Choose a name that is not reserved and reissue
the CREATE statement.
@@ -2791,7 +2791,7 @@ file error <file-system-error-number> on <file-name>.
Where <sql-object-name> is the ANSI name of the affected SQL database
object.
-Where <file-system-error-number> is a Trafodion platform file system
+Where <file-system-error-number> is a {project-name} platform file system
error code.
*Cause:* A CREATE or ALTER operation encountered a file system error
@@ -2888,12 +2888,12 @@ Unrecognized partitioning scheme for object <object-name>.
<object-name> is the name of the SQL object (table or index).
-*Cause:* The Trafodion database does not recognize the partitioning
+*Cause:* The {project-name} database does not recognize the partitioning
scheme stored in the metadata for the named object.
*Effect:* The named object is considered corrupt and is inaccessible.
-*Recovery:* None. Contact the Trafodion User Distribution List Consider
+*Recovery:* None. Contact the {project-name} User Distribution List Consider
running the VERIFY operation on the named object to check for
inconsistencies in the metadata with respect to the partitioning scheme.
@@ -2966,7 +2966,7 @@ default.
The specified schema location <directory> is already in use by schema <schema>.
```
-Where <directory> is the Trafodion platform subvolume name specified in
+Where <directory> is the {project-name} platform subvolume name specified in
the LOCATION clause of the CREATE SCHEMA command.
Where <schema> is the ANSI name of an existing schema that already uses
@@ -2995,15 +2995,15 @@ backup nodes.
== SQL 1307
```
-The schema location <directory> is reserved for Trafodion metadata.
+The schema location <directory> is reserved for {project-name} metadata.
```
-Where <directory> is the Trafodion platform subvolume name specified in
+Where <directory> is the {project-name} platform subvolume name specified in
the LOCATION clause of the CREATE SCHEMA command.
*Cause:* In a CREATE SCHEMA command, you specified subvolume in the
LOCATION clause, however subvolume names with the format
-ZSD<digit><anything> are reserved for Trafodion database software
+ZSD<digit><anything> are reserved for {project-name} database software
metadata schemas.
*Effect:* The operation fails.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/executor_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/executor_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/executor_msgs.adoc
index aa07a1c..191f033 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/executor_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/executor_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[executor-messages]]
@@ -60,7 +60,7 @@ The operation has been canceled.
Encoding of CONTROL QUERY DEFAULTs: <encoding>.
```
-*Cause:* Trafodion displays an internal CONTROL
+*Cause:* {project-name} displays an internal CONTROL
QUERY DEFAULT encoding.
*Effect:* None.
@@ -94,7 +94,7 @@ Explain information is not available for this query.
*Cause:* The explain default has been turned off for this query.
-*Effect:* Trafodion is not able to display explain
+*Effect:* {project-name} is not able to display explain
information.
*Recovery:* Turn the explain default on for this query.
@@ -129,7 +129,7 @@ The operation is prevented by a unique constraint.
*Cause:* You attempted to perform an operation that is prevented by a
unique constraint.
-*Effect:* Trafodion could not perform the
+*Effect:* {project-name} could not perform the
operation.
*Recovery:* Make the data you enter unique to be consistent with the
@@ -250,7 +250,7 @@ level, if appropriate.
Statement was recompiled.
```
-*Cause:* Trafodion recompiled the statement.
+*Cause:* {project-name} recompiled the statement.
*Effect:* The operation fails.
@@ -266,7 +266,7 @@ Table, index or view <name> was not found.
Where <name> is the name of the object.
-*Cause:* Trafodion could not find the object
+*Cause:* {project-name} could not find the object
<name>.
*Effect:* The operation fails.
@@ -316,7 +316,7 @@ starting a transaction.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-8605]]
@@ -350,7 +350,7 @@ committing a transaction.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-8607]]
@@ -383,7 +383,7 @@ rolling back a transaction.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-8609]]
@@ -415,7 +415,7 @@ Where <number> is the error number.
*Cause:* Transaction subsystem <name> has returned error <number> while
performing a waited rollback transaction. *Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-8612]]
@@ -440,13 +440,13 @@ mode.
SQL cannot commit or rollback a transaction that was started by application.
```
-*Cause:* An application started a transaction outside of Trafodion that Trafodion could not commit
+*Cause:* An application started a transaction outside of {project-name} that {project-name} could not commit
or rollback.
*Effect:* The operation fails.
*Recovery:* The application that started the transaction must perform a
-commit or rollback. Trafodion must start any transactions it will later commit or rollback.
+commit or rollback. {project-name} must start any transactions it will later commit or rollback.
<<<
[[SQL-8808]]
@@ -458,12 +458,12 @@ Module file <name> contains corrupted or invalid data.
Where <name> is the name of the file.
-*Cause:* Trafodion has detected corrupted or
+*Cause:* {project-name} has detected corrupted or
invalid data in the module file <name>.
-*Effect:* Trafodion could not execute the file.
+*Effect:* {project-name} could not execute the file.
-*Recovery:* Recompile the .mdf file, using the Trafodion compiler, to
+*Recovery:* Recompile the .mdf file, using the {project-name} compiler, to
create a valid module file.
[[SQL-8809]]
@@ -477,7 +477,7 @@ Where <name> is the name of the file.
Where <number> is the error number returned.
-*Cause:* Trafodion was unable to open module file
+*Cause:* {project-name} was unable to open module file
<name>.
*Effect:* The operation fails.
@@ -497,7 +497,7 @@ Begin transaction failed while preparing the statement.
*Effect:* The operation fails.
-*Recovery:* None. Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* None. Contact {project-support}.
[[SQL-8820]]
== SQL 8820
@@ -510,7 +510,7 @@ Transaction commit failed while closing the statement.
*Effect:* The operation fails.
-*Recovery:* None. Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* None. Contact {project-support}.
<<<
[[SQL-8821]]
@@ -524,7 +524,7 @@ Rollback transaction failed during the process of fetching the statement.
*Effect:* The operation fails.
-*Recovery:* None. Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* None. Contact {project-support}.
[[SQL-8824]]
== SQL 8824
@@ -553,7 +553,7 @@ The module could not be added.
*Effect:* The operation fails.
-*Recovery:* None. Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* None. Contact {project-support}.
[[SQL-8827]]
== SQL 8827
@@ -564,7 +564,7 @@ The request <name> could not be sent.
Where <name> is the name of the request.
-*Cause:* Trafodion was unable to send request <name>.
+*Cause:* {project-name} was unable to send request <name>.
*Effect:* The operation fails.
@@ -597,7 +597,7 @@ The input parameter is an invalid SQL transaction command.
*Effect:* The operation fails.
-*Recovery:* None. Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User Distribution mailing list].
+*Recovery:* None. Contact {project-support}.
<<<
[[SQL-8834]]
@@ -609,12 +609,12 @@ The SQL installation directory could not be found. Operating system error <numbe
Where <number> is the error number.
-*Cause:* Trafodion was unable to find the Trafodion installation directory and
+*Cause:* {project-name} was unable to find the {project-name} installation directory and
received an operating system error <number>.
*Effect:* The operation fails.
-*Recovery:* Locate the Trafodion installation directory,
+*Recovery:* Locate the {project-name} installation directory,
correct your syntax, and resubmit.
[[SQL-8836]]
@@ -667,8 +667,8 @@ Object name provided to CLI is not valid.
User application committed or aborted a transaction started by SQL. This transaction needs to be committed or aborted by calling SQL COMMIT or ROLLBACK WORK.
```
-*Cause:* Trafodion started a transaction that was committed or aborted by an embedded program,
-rather than by Trafodion.
+*Cause:* {project-name} started a transaction that was committed or aborted by an embedded program,
+rather than by {project-name}.
*Effect:* The operation fails.
@@ -842,7 +842,7 @@ An error while reading from file <name>.
Where <name> is the file name.
-*Cause:* Trafodion encountered an error while
+*Cause:* {project-name} encountered an error while
reading the module file <name>.
*Effect:* The operation fails.
@@ -858,13 +858,13 @@ Containing SQL is not permitted.
```
*Cause:* A stored procedure registered with the NO SQL attribute
-attempted to access Trafodion.
+attempted to access {project-name}.
*Effect:* The corresponding SQL request is rejected.
*Recovery:* Either change the definition of the stored procedure to
allow SQL access, or determine why the stored procedure contains
-Trafodion statements that might be called while the stored
+{project-name} statements that might be called while the stored
procedure is executing.
[[SQL-8888]]
@@ -893,11 +893,11 @@ is returned.
The SQL compiler failed to initialize properly. Query results may differ from what is expected, due to different compiler defaults.
```
-*Cause:* The Trafodion compiler failed to correctly initialize.
+*Cause:* The {project-name} compiler failed to correctly initialize.
*Effect:* Query results might be affected.
-*Recovery:* Stop the Trafodion and restart it.
+*Recovery:* Stop the {project-name} and restart it.
[[SQL-8901]]
== SQL 8901
@@ -906,29 +906,29 @@ The SQL compiler failed to initialize properly. Query results may differ from wh
The MXUDR server for this statement is no longer running. The statement will be assigned a new MXUDR server if it is executed again.
```
-*Cause:* During execution of a Trafodion statement, an
-attempt was made to contact a nonexistent Trafodion UDR server.
+*Cause:* During execution of a {project-name} statement, an
+attempt was made to contact a nonexistent {project-name} UDR server.
*Effect:* The operation fails.
-*Recovery:* Retry the Trafodion statement.
+*Recovery:* Retry the {project-name} statement.
<<<
[[SQL-8904]]
== SQL 8904
```
-Trafodion did not receive a reply from MXUDR, possibly caused by internal errors while executing user-defined routines.
+{project-name} did not receive a reply from MXUDR, possibly caused by internal errors while executing user-defined routines.
```
-*Cause:* During execution of a Trafodion statement,
-the Trafodion did not receive an expected reply from
-the Trafodion UDR server.
+*Cause:* During execution of a {project-name} statement,
+the {project-name} did not receive an expected reply from
+the {project-name} UDR server.
*Effect:* The operation fails.
-*Recovery:* Verify that the Trafodion UDR server is running. If
-not, the Trafodion statement will acquire a new
-Trafodion UDR server when it is next executed.
+*Recovery:* Verify that the {project-name} UDR server is running. If
+not, the {project-name} statement will acquire a new
+{project-name} UDR server when it is next executed.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/file_system_errors.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/file_system_errors.adoc b/docs/messages_guide/src/asciidoc/_chapters/file_system_errors.adoc
index 84e7a2b..aed6ea5 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/file_system_errors.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/file_system_errors.adoc
@@ -20,13 +20,13 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[file-system-errors]]
= File-System Errors
-Some error messages generated by the Trafodion platform include file-system error
+Some error messages generated by the {project-name} platform include file-system error
codes. For example:
====
@@ -41,7 +41,7 @@ This section lists all file-system error codes and provides the corresponding er
for each code number. The error text can sometimes help you troubleshoot a problem.
If the initial error message and file-system error text are insufficient to help you solve a
problem, or if you need more information,
-contact the mailto:user@trafodion.incubator.apache.org[Trafodion User mailing list].
+contact {project-support}.
[cols="15%l,85%",options="header",]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/generator_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/generator_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/generator_msgs.adoc
index aabf27a..157f08d 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/generator_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/generator_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[generator-messages]]
@@ -51,7 +51,7 @@ A plan using cluster sampling could not be produced for this query.
result set and only if there is no WHERE clause in the SELECT statement.
This query does not satisfy these conditions.
-*Effect:* Trafodion is unable to compile the query.
+*Effect:* {project-name} is unable to compile the query.
*Recovery:* Rewrite the query (for example, using nested queries) so
that cluster sampling is performed on a base table with no WHERE-clause
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/introduction.adoc b/docs/messages_guide/src/asciidoc/_chapters/introduction.adoc
index 6d3405e..45d938f 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/introduction.adoc
@@ -20,18 +20,18 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Introduction
== Message Handling
-Trafodion reports exception condition messages at a Trafodion Database
+{project-name} reports exception condition messages at a {project-name} Database
Connectivity Service conversational interface (DCS) window and in the
Trafodion Command Interface (TrafCI).
-Most Trafodion exception condition messages describe error conditions
+Most {project-name} exception condition messages describe error conditions
for which recovery action is required. Some messages are warnings that
provide information for which no action is required.
@@ -39,19 +39,19 @@ Error messages that appear in response to SQL commands are logged to the
DCS application's log file if you have used the LOG command to request
them.
-The format of a Trafodion error is "*** ERROR" followed by the error number
+The format of a {project-name} error is "*** ERROR" followed by the error number
in brackets, and the descriptive text. Use the error number shown to find
information about a particular error in this manual. For example, information
-for Trafodion error 1125 can be found under "SQL 1125."
+for {project-name} error 1125 can be found under "SQL 1125."
Messages are listed in this manual in numeric order, broken down by the component
that produced them.
[[viewing-trafodion-database-messages]]
-== Viewing Trafodion Database Messages
+== Viewing {project-name} Database Messages
The message key is a sequential SQL message number that is returned
-automatically by Trafodion when an exception condition
+automatically by {project-name} when an exception condition
occurs. For example, the following message might be displayed within
your application development tool while you prepare an embedded SQL
program:
@@ -71,7 +71,7 @@ manual, you will find the following message information for ERROR[1000]:
*Cause:* You specified a statement with incorrect syntax.
-*Effect:* The Trafodion statement fails.
+*Effect:* The {project-name} statement fails.
*Recovery:* Correct the syntax and resubmit.
====
@@ -87,30 +87,30 @@ The ANSI SQL SQLSTATE variable is a five-character string with a
two-character class code followed by a three-character subclass code. An
SQLSTATE value of 00000 indicates successful completion.
-Trafodion extends the ANSI SQL SQLSTATE values to include other situations
+{project-name} extends the ANSI SQL SQLSTATE values to include other situations
not described by the ANSI values. If an ANSI SQL SQLSTATE value exists for
-an error condition, the Trafodion database software returns that value.
-Otherwise, Trafodion returns an SQLSTATE value that is defined by the Trafodion
+an error condition, the {project-name} database software returns that value.
+Otherwise, {project-name} returns an SQLSTATE value that is defined by the {project-name}
database software.
-Trafodion also returns a numeric SQLCODE value after SQL statement execution.
+{project-name} also returns a numeric SQLCODE value after SQL statement execution.
SQLCODE values with negative numbers signify errors.
SQLCODE values with positive numbers other than 0 (successful completion) or 100
-(no data was found) signify warning messages. Trafodion identifies all messages
+(no data was found) signify warning messages. {project-name} identifies all messages
by their unsigned SQLCODE value and their calculated SQLSTATE value. The SQLCODE
-is used to calculate the SQLSTATE value for all Trafodion messages other than
+is used to calculate the SQLSTATE value for all {project-name} messages other than
those for which an ANSI SQL SQLSTATE value exists.
The SQLCODE parameter is a deprecated feature that is supported to
maintain compatibility with earlier versions of the American standard.
<<sqlstate-values,_SQLSTATE Values_>> identifies the equivalent SQLSTATE and
-SQLCODE values for Trafodion warning and error messages.
+SQLCODE values for {project-name} warning and error messages.
[[getting-help]]
== Getting Help
-Some messages have no recovery and you will be instructed to contact the
-mailt:user@trafodion.incubator.apache.org[Trafodion user mailing list].
+Some messages have no recovery and you will be instructed to contact
+{project-support}.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/optimizer_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/optimizer_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/optimizer_msgs.adoc
index 802bce5..7313382 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/optimizer_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/optimizer_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[optimizer-messages]]
@@ -51,7 +51,7 @@ The metadata table HISTOGRAMS or HISTOGRAM_INTERVALS contains invalid values. If
*Cause:* You have manually modified the metadata table, and now it
contains invalid values.
-*Effect:* Trafodion is unable to complete
+*Effect:* {project-name} is unable to complete
compilation.
*Recovery:* Undo your changes using the CLEAR option in UPDATE
@@ -68,7 +68,7 @@ The metadata table HISTOGRAMS or HISTOGRAM_INTERVALS contains invalid boundary v
*Cause:* You have manually modified the metadata table, and now it
contains an invalid boundary value.
-*Effect:* The Trafodion database uses default histograms to compile the
+*Effect:* The {project-name} database uses default histograms to compile the
query. This is a warning message.
*Recovery:* Undo your changes using the CLEAR option in UPDATE
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/parser_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/parser_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/parser_msgs.adoc
index 78cb0ae..fb129a9 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/parser_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/parser_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[parser-and-compilation-messages]]
@@ -172,8 +172,8 @@ Character set <name> is not yet supported.
Where <name> is the name of the character set.
*Cause:* You specified character set <name> that is not supported for
-use in a Trafodion object, such as a table or module. Examples include
-creating a KANJI or KSC5601 column in a Trafodion table.
+use in a {project-name} object, such as a table or module. Examples include
+creating a KANJI or KSC5601 column in a {project-name} table.
*Effect:* The operation fails.
@@ -249,7 +249,7 @@ Scale <value> cannot exceed precision <value>.
```
*Cause:* You defined a scale value with greater precision than
-Trafodion allows.
+{project-name} allows.
*Effect:* The operation fails.
@@ -278,7 +278,7 @@ Precision of decimal, <value>, cannot exceed 18.
An unsigned integer was expected, not <value>.
```
-*Cause:* You specified an unexpected value, <value>. Trafodion
+*Cause:* You specified an unexpected value, <value>. {project-name}
requires an unsigned integer.
*Effect:* The operation fails.
@@ -292,7 +292,7 @@ requires an unsigned integer.
An unsigned smallint was expected, not <value>.
```
-*Cause:* You specified an unexpected value, <value>. Trafodion
+*Cause:* You specified an unexpected value, <value>. {project-name}
requires an unsigned smallint.
*Effect:* The operation fails.
@@ -307,7 +307,7 @@ requires an unsigned smallint.
An unsigned number was expected within the parentheses, not <value>.
```
-*Cause:* You specified an unexpected value, <value>. Trafodion
+*Cause:* You specified an unexpected value, <value>. {project-name}
requires an unsigned number.
*Effect:* The operation fails.
@@ -321,7 +321,7 @@ requires an unsigned number.
An unsigned number was expected as the first operand within parentheses, not <value>.
```
-*Cause:* You specified an unexpected value, <value>. Trafodion
+*Cause:* You specified an unexpected value, <value>. {project-name}
requires an unsigned number.
*Effect:* The operation fails.
@@ -336,7 +336,7 @@ requires an unsigned number.
An unsigned number was expected as the second operand within parentheses, not <value>.
```
-*Cause:* You specified an unexpected value, <value>. Trafodion
+*Cause:* You specified an unexpected value, <value>. {project-name}
requires an unsigned number.
*Effect:* The operation fails.
@@ -367,7 +367,7 @@ The COLLATE clause in a sort specification is not yet supported.
*Cause:* You attempted to perform a COLLATE clause in a sort
specification, which is not supported.
-*Effect:* Trafodion ignores the COLLATE clause.
+*Effect:* {project-name} ignores the COLLATE clause.
*Recovery:* Remove the COLLATE clause and resubmit.
@@ -425,7 +425,7 @@ must be separated by commas.
*Cause:* You specified an invalid name <name>, which must have only one
name part.
-*Effect:* Trafodion could not prepare the
+*Effect:* {project-name} could not prepare the
statement.
*Recovery:* Correct the name and resubmit.
@@ -855,7 +855,7 @@ The ALLOCATE value must be between 1 and <number>.
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for correct size
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for correct size
values, and resubmit.
[[SQL-3058]]
@@ -883,7 +883,7 @@ The specified size value (in the MAXSIZE clause or EXTENT size clause) is not va
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for correct size
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for correct size
values, and resubmit.
[[SQL-3060]]
@@ -897,7 +897,7 @@ The specified percentage value in the DSLACK clause is not valid.
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for correct
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for correct
percentage values, and resubmit.
<<<
@@ -912,7 +912,7 @@ The format of the specified location name <name> is not valid.
*Effect:* The operation fails.
-*Recovery:* See the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_] for correct name
+*Recovery:* See the {docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_] for correct name
format, and resubmit.
[[SQL-3062]]
@@ -967,7 +967,7 @@ The primary key constraint cannot be droppable when the STORE BY PRIMARY KEY cla
*Cause:* You defined a primary key as droppable in a table that includes
STORE BY PRIMARY KEY in its definition, which is not supported.
-*Effect:* Trafodion is unable to process this
+*Effect:* {project-name} is unable to process this
definition.
*Recovery:* Change the definition of the primary key constraint so that
@@ -998,7 +998,7 @@ The ALLOCATE and DEALLOCATE clauses cannot coexist in the same ALTER INDEX state
*Cause:* You specified an ALTER INDEX statement with both an ALLOCATE
and a DEALLOCATE clause, which is not supported.
-*Effect:* Trafodion ignores the ALTER INDEX
+*Effect:* {project-name} ignores the ALTER INDEX
statement.
*Recovery:* Correct the ALTER INDEX statement to include either ALLOCATE
@@ -1309,7 +1309,7 @@ The [NO]AUDIT clause is not allowed in the CREATE INDEX statements.
*Cause:* You specified a CREATE INDEX statement with the [NO]AUDIT
clause, which is not supported.
-*Effect:* Trafodion ignores the CREATE INDEX
+*Effect:* {project-name} ignores the CREATE INDEX
statement.
*Recovery:* Correct the syntax and resubmit.
@@ -1828,7 +1828,7 @@ option, which is not supported.
The statement just entered is currently not supported.
```
-*Cause:* You specified a statement that is not supported by Trafodion.
+*Cause:* You specified a statement that is not supported by {project-name}.
*Effect:* The operation fails.
@@ -2020,7 +2020,7 @@ Positioned UPDATE or DELETE is allowed only in embedded SQL.
```
*Cause:* You attempted to perform a positioned UPDATE or DELETE, which
-is supported only in embedded Trafodion.
+is supported only in embedded {project-name}.
*Effect:* The operation fails.
@@ -2050,7 +2050,7 @@ Environment variable <value> is being ignored because this version of the code i
Where <value> is the environment variable value specified.
-*Cause:* Trafodion is ignoring the environment
+*Cause:* {project-name} is ignoring the environment
variable you specified. Query results might not match expected results.
*Effect:* None.
@@ -2218,7 +2218,7 @@ Procedure parameter <name> was not used.
Where <name> is the name of the procedure parameter.
-*Cause:* Trafodion did not use procedure parameter <name>.
+*Cause:* {project-name} did not use procedure parameter <name>.
*Effect:* None.
@@ -2394,7 +2394,7 @@ Dynamic SQL statements are not allowed in compound statements.
```
*Cause:* You specified a compound statement that contains dynamic
-Trafodion statements.
+{project-name} statements.
*Effect:* The operation fails.
@@ -2437,7 +2437,7 @@ in the length declaration of the data type.
One or more of the following external (host-language) data types incorrectly appears within the SQL query or operation: <name>.
```
-*Cause:* You specified a Trafodion query or attempted
+*Cause:* You specified a {project-name} query or attempted
to perform an operation with an incorrect data type.
The operation fails.
@@ -2563,7 +2563,7 @@ not a quoted string.
Where <string> is the dynamic parameter or host variable that was
specified.
-*Cause:* Trafodion does not support the use of
+*Cause:* {project-name} does not support the use of
dynamic parameters or host variables in DDL statements.
The operation fails.
@@ -2621,7 +2621,7 @@ supported.
Union operands <table-1> and <table-2> have different access/lock modes.
```
-*Cause:* Trafodion attempted to compile a UNION
+*Cause:* {project-name} attempted to compile a UNION
query that has an access/lock mode that can be applied to both branches
of the access/lock mode or only to the second branch of the UNION.
@@ -2770,7 +2770,7 @@ EXTERNAL NAME clause is badly formed.
*Cause:* In the CREATE PROCEDURE statement, the EXTERNAL NAME clause you
specified does not conform to the required syntax.
-*Effect:* Trafodion is unable to create the
+*Effect:* {project-name} is unable to create the
procedure.
*Recovery:* Correct the syntax and resubmit.
@@ -3004,12 +3004,12 @@ operation as a table reference.
== SQL 3220
```
-SHOWDDL failed for object <object-name> because an SQL/MP display option was used on a Trafodion object.
+SHOWDDL failed for object <object-name> because an SQL/MP display option was used on a {project-name} object.
```
Where <object-name> specifies the ANSI name of a table, view, or ALIAS.
-*Cause:* SHOWDDL was given the display option with a Trafodion
+*Cause:* SHOWDDL was given the display option with a {project-name}
table given as an argument.
*Effect:* SHOWDDL does not display output.
@@ -3022,7 +3022,7 @@ object.
== SQL 3225
```
-SHOWLABEL failed for object <object-name>. The object does not exist in the given namespace <name-space>, the object is not accessible, or the object type is not supported. SHOWLABEL supports only Trafodion tables, views and indexes.
+SHOWLABEL failed for object <object-name>. The object does not exist in the given namespace <name-space>, the object is not accessible, or the object type is not supported. SHOWLABEL supports only {project-name} tables, views and indexes.
```
Where <object-name> is the specified name of an object.
@@ -3043,11 +3043,11 @@ namespace of a valid, supported, and accessible object.
== SQL 3226
```
-SHOWLABEL failed for physical location name <location-name>. Object does not exist or object type is not supported. SHOWLABEL supports only Trafodion tables, views, and indexes.
+SHOWLABEL failed for physical location name <location-name>. Object does not exist or object type is not supported. SHOWLABEL supports only {project-name} tables, views, and indexes.
```
Where <location-name> specifies the physical location name of a
-Trafodion object.
+{project-name} object.
*Cause:* SHOWLABEL was given an invalid physical location as an
argument.
@@ -3061,14 +3061,14 @@ argument.
== SQL 3228
```
-SHOWLABEL failed for physical location name <location-name>. SHOWLABEL supports only the data forks of Trafodion tables, views, and indexes.
+SHOWLABEL failed for physical location name <location-name>. SHOWLABEL supports only the data forks of {project-name} tables, views, and indexes.
```
Where <location-name> specifies the physical location name of a
-Trafodion object.
+{project-name} object.
*Cause:* SHOWLABEL supports only the physical names of data forks of
-Trafodion objects (physical location names that end in "00"). SHOWLABEL
+{project-name} objects (physical location names that end in "00"). SHOWLABEL
does not support resource forks.
*Effect:* SHOWLABEL does not display output.
@@ -3126,7 +3126,7 @@ Hexadecimal representation of string literals associated with character set <nam
```
*Cause:* You used a hexadecimal format to represent a character string
-that is not supported by Trafodion.
+that is not supported by {project-name}.
*Effect:* The operation fails.
@@ -3203,7 +3203,7 @@ A DDL statement could not be translated into a statement consisting of single-by
```
*Cause:* The DDL statement coded in unicode contains non-ISO88591
-characters. Trafodion does not support arbitrary
+characters. {project-name} does not support arbitrary
unicode characters.
*Effect:* The operation fails.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/sort_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/sort_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/sort_msgs.adoc
index 9cdf9fa..9039a57 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/sort_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/sort_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[sort-messages]]
@@ -33,7 +33,7 @@
UPDATE STATISTICS encountered an error from statement <name>.
```
-*Cause:* UPDATE STATISTICS encountered an error from the Trafodion statement <name>.
+*Cause:* UPDATE STATISTICS encountered an error from the {project-name} statement <name>.
*Effect:* The operation fails.
@@ -51,11 +51,11 @@ Unable to DROP object <name>.
*Cause:* UPDATE STATISTICS encountered an error during a DROP of the
object <name>.
-*Effect:* Trafodion is unable to continue processing.
+*Effect:* {project-name} is unable to continue processing.
-*Recovery:* Resubmit the statement. If this does not correct the problem, stop and restart Trafodion.
+*Recovery:* Resubmit the statement. If this does not correct the problem, stop and restart {project-name}.
If this does not correct the problem,
-contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+contact {project-support}.
<<<
[[SQL-9202]]
@@ -86,7 +86,7 @@ Column names must be unique when specified in column list: (<name>).
*Cause:* You specified a non unique column name in the specified column list.
-*Effect:* Trafodion is unable to continue processing.
+*Effect:* {project-name} is unable to continue processing.
*Recovery:* Correct the syntax and resubmit.
@@ -101,7 +101,7 @@ Invalid option <option> specified. Value must be <range>.
*Cause:* You specified an invalid option for UPDATE STATISTICS. The
value <range> specifies the valid range for this option.
-*Effect:* Trafodion is unable to continue
+*Effect:* {project-name} is unable to continue
processing.
*Recovery:* Correct the syntax and resubmit.
@@ -115,7 +115,7 @@ UPDATE STATISTICS is not supported for object <name>.
*Cause:* You attempted to run UPDATE STATISTICS against an object that is not supported.
-*Effect:* Trafodion is unable to continue processing.
+*Effect:* {project-name} is unable to continue processing.
*Recovery:* Correct the syntax and resubmit.
@@ -127,12 +127,12 @@ UPDATE STATISTICS is not supported for object <name>.
You are not authorized to read/write object <name>. Verify that you have the necessary access privileges.
```
-*Cause:* Trafodion could not perform an UPDATE
+*Cause:* {project-name} could not perform an UPDATE
STATISTICS statement because you are not authorized to perform this
operation against this table. You must either own the object <name> or
be the super ID.
-*Effect:* Trafodion is unable to continue processing.
+*Effect:* {project-name} is unable to continue processing.
*Recovery:* Resubmit after checking the table location and access privileges.
@@ -145,7 +145,7 @@ The specified SAMPLE option generated an empty sample set. Modify the SAMPLE opt
*Cause:* The SAMPLE option you specified generated an empty sample set.
-*Effect:* Trafodion is unable to continue processing.
+*Effect:* {project-name} is unable to continue processing.
*Recovery:* Modify the SAMPLE option and resubmit.
@@ -162,8 +162,8 @@ Column definitions could not be accessed.
*Effect:* The operation fails.
*Recovery:* Resubmit the statement. If this does not correct the
-problem, stop and restart the Trafodion database software. If this does
-not correct the problem, report the entire message to mailto:user@trafodion.incubator.apache.org[the Trafodion User mailing list].
+problem, stop and restart the {project-name} database software. If this does
+not correct the problem, report the entire message to {project-support}.
[[SQL-9209]]
== SQL 9209
@@ -228,11 +228,11 @@ Object <name> could not be created.
*Cause:* UPDATE STATISTICS encountered an error during a CREATE of the object <name>.
-*Effect:* Trafodion is unable to continue processing.
+*Effect:* {project-name} is unable to continue processing.
*Recovery:* Resubmit the statement. If this does not correct the
-problem, stop and restart the Trafodion database software. If this does
-not correct the problem, report the entire message to mailto:user@trafodion.incubator.apache.org[the Trafodion User mailing list].
+problem, stop and restart the {project-name} database software. If this does
+not correct the problem, report the entire message to {project-support}.
<<<
[[SQL-10007-]]
@@ -246,7 +246,7 @@ Sort failed while writing to a scratch file with error <system-error>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
[[SQL-10011-]]
== SQL 10011
@@ -261,7 +261,7 @@ Where <system-error> is the error returned.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-10013-]]
@@ -278,7 +278,7 @@ Sort could not find any appropriate disks for overflow.
*Recovery:* Make sure there are appropriate disks with enough space for
scratch file use. Disks such as optical disks, phantom disks, and
virtual disks are not considered suitable. See the
-http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]
+{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]
for more information on how to influence the placement of scratch files.
[[SQL-10014-]]
@@ -293,7 +293,7 @@ Sort ran out of memory while allocating an internal data structure.
*Effect:* The operation fails.
*Recovery:* None. This is an internal error.
-Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+Contact {project-support}.
<<<
[[SQL-10015-]]
@@ -307,7 +307,7 @@ Sort failed while calling PROCESSHANDLE_GETMINE_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
[[SQL-10016-]]
== SQL 10016
@@ -320,7 +320,7 @@ Sort failed while calling PROCESSHANDLE_DECOMPOSE_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-10017-]]
@@ -334,7 +334,7 @@ Sort failed while calling DEVICE_GETINFOBYLDEV_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
[[SQL-10018-]]
== SQL 10018
@@ -347,7 +347,7 @@ Sort failed while calling FILENAME_FILESTART_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-10019-]]
@@ -361,7 +361,7 @@ Sort failed while calling FILENAME_FILENEXT_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
[[SQL-10020-]]
== SQL 10020
@@ -374,7 +374,7 @@ Sort failed while calling FILENAME_FINDFINISH_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-10021-]]
@@ -388,7 +388,7 @@ Sort failed while calling FILE_GETINFOLISTBYNAME_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
[[SQL-10022-]]
== SQL 10022
@@ -401,7 +401,7 @@ Sort failed while calling FILE_CREATE with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
<<<
[[SQL-10023-]]
@@ -415,7 +415,7 @@ Sort failed while calling FILE_OPEN_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact {project-support}.
[[SQL-10024-]]
== SQL 10024
@@ -428,7 +428,7 @@ Sort failed while calling SETMODE_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact the {project-support}.
<<<
[[SQL-10027-]]
@@ -442,7 +442,7 @@ Sort failed while calling FILE_GETINFOLIST with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact the {project-support}.
[[SQL-10028-]]
== SQL 10028
@@ -455,7 +455,7 @@ Sort failed while calling POSITION with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact the {project-support}.
<<<
[[SQL-10029-]]
@@ -469,7 +469,7 @@ Sort failed while calling FILE_GETINFO_ with error <number>.
*Effect:* The operation fails.
-*Recovery:* Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+*Recovery:* Contact the {project-support}.
[[SQL-10047-]]
== SQL 10047
@@ -483,7 +483,7 @@ Sort Error: Wrong length read.
*Effect:* The operation fails.
*Recovery:* None. This is an internal error.
-Contact the mailto:user@trafodion.incubator.apache.org[Trafodion User distribution list].
+Contact {project-support}.
<<<
[[SQL-10048-]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/sqlstate.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/sqlstate.adoc b/docs/messages_guide/src/asciidoc/_chapters/sqlstate.adoc
index e4e730d..91aeda2 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/sqlstate.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/sqlstate.adoc
@@ -20,13 +20,13 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[sqlstate]]
= SQLSTATE
-Trafodion returns SQLSTATE values that are defined
+{project-name} returns SQLSTATE values that are defined
in the ISO/ANSI SQL standard and implementation-defined SQLSTATE values. See
Subclause 22, "Status Codes" in the ISO/ANSI SQL92 Standard "Database
Language SQL."
@@ -45,11 +45,11 @@ values mapped to SQLSTATE 42000 in the table below.
** To deal with the problem of ambiguous SQLCODE values, we recommends retrieving the error message
text or the SQLCODE value in addition to the SQLSTATE.
-* SQLSTATE values for some Trafodion error and warning messages might be subject to change:
+* SQLSTATE values for some {project-name} error and warning messages might be subject to change:
-** In the future, Trafodion might return different SQLSTATE values for error conditions than it does now.
+** In the future, {project-name} might return different SQLSTATE values for error conditions than it does now.
-** In the future, the Trafodion error handling might use a different error path, and therefore return a
+** In the future, the {project-name} error handling might use a different error path, and therefore return a
slightly different SQLCODE and implementation defined SQLSTATE value for an error.
[[sqlstate-values]]
@@ -95,10 +95,10 @@ numbers) and error messages (negative SQLCODE numbers).
| 0150T | 1029 | Object <object-name> could not be created.
| 0150U | 1030 | File label <name> could not be accessed. File System error <error>.
| 0150V | 1031 | Object <object-name> could not be dropped.
-| 0150Y | 1034 | Trafodion was not able to initialize.
+| 0150Y | 1034 | {project-name} was not able to initialize.
| 0150Z | 1035 | Catalog <catalog-name> already exists
| 01510 | 1036 | Only super ID can execute DROP SQL.
-| 01511 | 1037 | Trafodion is not installed on system <node>.
+| 01511 | 1037 | {project-name} is not installed on system <node>.
| 01512 | 1038 | Not all catalogs have been dropped from the system.
| 01513 | 1039 | The drop SQL statement could not be executed.
| 01514 | 1040 | The use of ALTER on metadata tables is not permitted.
@@ -188,7 +188,7 @@ numbers) and error messages (negative SQLCODE numbers).
| 0153Y | 1142 | Attempting to add a column with a NULL, UNIQUE, CHECK, PRIMARY KEY, or FOREIGN KEY constraint defined. This is not supported for a non-audited table.
| 0153Z | 1143 | Validation for constraint <name> failed; incompatible data exists in referencing base table <name> and referenced base table <name>. To display the data violating the constraint, please use the following DML statement: <text>
| 01540 | 1144 | Expected a quoted string in first key clause for column <name> on table <name>, value detected is (<num>).
-| 01541 | 1145 | The catalog name <name> is reserved for the Trafodion metadata.
+| 01541 | 1145 | The catalog name <name> is reserved for the {project-name} metadata.
| 01542 | 1146 | Unable to alter object <name> because it is not a <name>.
| 01543 | 1147 | System-generated column <name> of base table <name> cannot appear in a unique or primary key constraint definition.
| 01544 | 1148 | System-generated column <name> of base table <name> cannot appear in a referential integrity constraint definition.
@@ -198,16 +198,16 @@ numbers) and error messages (negative SQLCODE numbers).
| 01554 | 1184 | Insufficient privilege on <name>.
| 01555 | 1185 | The location name is either invalid or missing.
| 01556 | 1186 | Column <name> is of type <type>, incompatible with the default value's type, <type>.
-| 01557 | 1187 | The schema name <name> is reserved for the Trafodion metadata.
+| 01557 | 1187 | The schema name <name> is reserved for the {project-name} metadata.
| 01558 | 1188 | Unable to create referential integrity constraint <name> for table <name> due to circular dependency: <name>.
| 01566 | 1222 | Invalid file type <name>.
| 01568 | 1224 | Invalid data type for routine param <name>.
-| 01569 | 1225 | Error on access to PROCS table. Trafodion error <integer>.
-| 0156A | 1226 | Error on access to PARAMS table. Trafodion error <integer>.
+| 01569 | 1225 | Error on access to PROCS table. {project-name} error <integer>.
+| 0156A | 1226 | Error on access to PARAMS table. {project-name} error <integer>.
| 0156F | 1231 | Unable to create user-defined routine <string>.
| 01600 | 2000 | Error messages for compiler main, IPC, and DEFAULTS table; assertions for optimizer.
| 01601 | 2001 | Error or warning <num> occurred while opening or reading from DEFAULTS table <name>. Using <name> values.
-| 01602 | 2002 | Internal error: cannot create Trafodion compiler server.
+| 01602 | 2002 | Internal error: cannot create {project-name} compiler server.
| 01603 | 2003 | Internal error: cannot establish connection with MXCMP server.
| 01604 | 2004 | Internal error: error from MXCMP; cannot work on this query.
| 01605 | 2005 | Internal error: from compilation, no errors in diagnostics yet for statement: <name>
@@ -764,7 +764,7 @@ Suggestion: a) Inspect the CQS in effect; or b) Raise the optimization level to
| 01KN3 | 8831 | Either no current context or the module to which the statement belongs is not added to the current context.
| 01KN4 | 8832 | Transaction has not been started.
| 01KN5 | 8833 | The input parameter is an invalid SQL transaction command.
-| 01KN6 | 8834 | Unable to find Trafodion installation directory. Operating system error <num>.
+| 01KN6 | 8834 | Unable to find {project-name} installation directory. Operating system error <num>.
| 01KN7 | 8835 | Invalid SQL descriptor information requested.
| 01KN8 | 8836 | Invalid update column for cursor.
| 01KN9 | 8837 | Invalid user id.
@@ -814,9 +814,9 @@ Suggestion: a) Inspect the CQS in effect; or b) Raise the optimization level to
| 01KOY | 8898 | Internal error in CLI.
| 01KP1 | 8901 | The MXUDR server for this statement is no longer running. The statement will be assigned a new MXUDR server if it is executed again.
| 01KP2 | 8902 | Internal error: MXUDR returned an invalid UDR handle.
-| 01KP3 | 8903 | An attempt was made by the Trafodion to kill the MXUDR server for this statement <process-name>. PROCESS_STOP_ returned <value>.
+| 01KP3 | 8903 | An attempt was made by the {project-name} to kill the MXUDR server for this statement <process-name>. PROCESS_STOP_ returned <value>.
| 01KP4 | 8904 | Unable to receive reply from MXUDR, possibly caused by internal errors while executing user-defined routines.
-| 01KP6 | 8906 | An invalid or corrupt MXUDR reply could not be processed, possibly due to memory corruption in MXUDR while executing friendly user-defined routines or an internal error in Trafodion.
+| 01KP6 | 8906 | An invalid or corrupt MXUDR reply could not be processed, possibly due to memory corruption in MXUDR while executing friendly user-defined routines or an internal error in {project-name}.
| 01L5K | 9200 | UPDATE STATISTICS encountered an error from statement <name>.
| 01L5L | 9201 | Unable to DROP object <name>.
| 01L5M | 9202 | UPDATE STATISTICS has located previously generate histogram that are not being regenerated. This might affect the plans that will be generated. Missing column lists are <column-list>.
@@ -984,8 +984,8 @@ Suggestion: a) Inspect the CQS in effect; or b) Raise the optimization level to
| 01PE6 | 13510 | The SQL declare section might not contain COPY or REPLACE.
| 01PE7 | 13511 | End of input file while processing EXEC SQL.
| 01PE8 | 13512 | Input file error while processing EXEC SQL.
-| 01PE9 | 13513 | The BIT data type is not implemented in the Trafodion software.
-| 01PEA | 13514 | The CHARACTER SET attribute is not implemented in Trafodion.
+| 01PE9 | 13513 | The BIT data type is not implemented in the {project-name} software.
+| 01PEA | 13514 | The CHARACTER SET attribute is not implemented in {project-name}.
| 01PEB | 13515 | Picture <name> is not valid for a host variable.
| 01PEC | 13516 | Unexpected end of input file encountered after line <num>.
| 01PED | 13517 | Line <num> is too long to process and has been truncated.
@@ -1064,16 +1064,16 @@ Suggestion: a) Inspect the CQS in effect; or b) Raise the optimization level to
| 01Y01 | 16001 | No message found for error or warning <sqlcode>.
| 02000 | 100 | The "no data" completion condition (SQLCODE = +100).
| 01Z01 | 25001 | Program <executable>, executing on <node>, has encountered a version error.
-| 01Z2S | 25100 | Remote node <node> runs an incompatible version of Trafodion. The Trafodion version (version) of <node> is <version-1>, the local node does not support versions older than <version-2>.
-| 01Z2T | 25101 | Remote node <node> runs an incompatible version of Trafodion. The Trafodion version (version) of <node> is <version-1>, the local node supports only version <version-2>.
-| 01Z2U | 25102 | Remote node <node> runs a version of Trafodion which cannot interoperate with other versions. The Trafodion version (version) of <node> is <version-1>.
+| 01Z2S | 25100 | Remote node <node> runs an incompatible version of {project-name}. The {project-name} version (version) of <node> is <version-1>, the local node does not support versions older than <version-2>.
+| 01Z2T | 25101 | Remote node <node> runs an incompatible version of {project-name}. The {project-name} version (version) of <node> is <version-1>, the local node supports only version <version-2>.
+| 01Z2U | 25102 | Remote node <node> runs a version of {project-name} which cannot interoperate with other versions. The {project-name} version (version) of <node> is <version-1>.
| 01Z8C | 25300 | Module <module> has module version <version-1>; node <node> does not support module versions lower than <version-2>.
| 01Z8D | 25301 | Module <module> has module version <version-1>; the local node does not support module versions higher than <version-2>.
| 01Z8I | 25306 | A required system module has module version <version-1>; node <node> does not support query plans from modules with module version lower than <version-2>.
-| 01Z8J | 25307 | The query plan can be executed only by a node with Trafodion version (version) <version-1>, the version of <node> is <version-1>.
-| 01Z8K | 25308 | The query plan has plan version <version-1>, the local Trafodion version (version) can execute only query plans with plan version <version-1>.
-| 01Z8L | 25309 | Module <module> can be executed only by a node with Trafodion version (version) version1, the version of <node> is <version-1>.
-| 01Z8M | 25310 | Module <module> has module version <version-1>, the local Trafodion version (version) can execute only modules with module version <version-1>.
+| 01Z8J | 25307 | The query plan can be executed only by a node with {project-name} version (version) <version-1>, the version of <node> is <version-1>.
+| 01Z8K | 25308 | The query plan has plan version <version-1>, the local {project-name} version (version) can execute only query plans with plan version <version-1>.
+| 01Z8L | 25309 | Module <module> can be executed only by a node with {project-name} version (version) version1, the version of <node> is <version-1>.
+| 01Z8M | 25310 | Module <module> has module version <version-1>, the local {project-name} version (version) can execute only modules with module version <version-1>.
| 01Z8N | 25311 | System module <module> has a wrong module version. The expected module version is <version-1>. the actual module version is <version-2>.
| 02000 | 100 |T h e "no data" completion condition (SQLCODE=+100).
| 07001 | -15015 |PARAM <name> (value <num>) cannot be converted to type <type>.
@@ -1636,7 +1636,7 @@ Suggestion: a) Inspect the CQS in effect; or b) Raise the optimization level to
| X013X | -1141 | Could not obtain an up-and-audited DAM volume. Please check your system configuration.
| X013Z | -1143 | Validation for constraint <name> failed; incompatible data exists in referencing base table <name> and referenced base table <name>. To display the data violating the constraint, please use the following DML statement: <name>
| X0140 | -1144 | Expected a quoted string in first key clause for column <name> on table <name>, value detected is (<name>).
-| X0141 | -1145 | The catalog name <name> is reserved for Trafodion metadata.
+| X0141 | -1145 | The catalog name <name> is reserved for {project-name} metadata.
| X0142 | -1146 | Unable to alter object <name> because it is not a <name>.
| X0143 | -1147 | System-generated column <name> of base table <name> cannot appear in a unique or primary key constraint definition.
| X0144 | -1148 | System-generated column <name> of base table <name> cannot appear in a referential integrity constraint definition.
@@ -1645,12 +1645,12 @@ Suggestion: a) Inspect the CQS in effect; or b) Raise the optimization level to
| X0153 | -1183 | Cannot instantiate module <name>, conflicting lock exists.
| X0154 | -1184 | Insufficient privilege on <name>.
| X0155 | -1185 | The location name is either invalid or missing.
-| X0157 | -1187 | The schema name <name> is reserved for Trafodion metadata.
+| X0157 | -1187 | The schema name <name> is reserved for {project-name} metadata.
| X0158 | -1188 | Unable to create referential integrity constraint <name> for table <name> due to circular dependency: <name>.
| X0166 | -1222 | Invalid file type <type>.
| X0168 | -1224 | Invalid data type for routine param <name>.
-| X0169 | -1225 | Error on access to PROCS table. Trafodion error <integer>.
-| X016A | -1226 | Error on access to PARAMS table. Trafodion error <integer>.
+| X0169 | -1225 | Error on access to PROCS table. {project-name} error <integer>.
+| X016A | -1226 | Error on access to PARAMS table. {project-name} error <integer>.
| X016F | -1231 | Unable to create user-defined routine <routine-name>.
| X0200 | -2000 | Error messages for compiler main, IPC, and DEFAULTS table; assertions for optimizer.
| X0201 | -2001 | Error or warning <num> occurred while opening or reading from DEFAULTS table <name>. Using <name> values.
@@ -1800,9 +1800,9 @@ level might result in a long compile time.
| X080J | -8883 |
| X08P1 | -8901 | The MXUDR server for this statement is no longer running. The statement will be assigned a new MXUDR server if it is executed again.
| X08P2 | -8902 | Internal error: MXUDR returned an invalid UDR handle.
-| X08P3 | -8903 | An attempt was made by Trafodion to kill the MXUDR server for this statement <process-name>. PROCESS_STOP_ returned <value>.
+| X08P3 | -8903 | An attempt was made by {project-name} to kill the MXUDR server for this statement <process-name>. PROCESS_STOP_ returned <value>.
| X08P4 | -8904 | Unable to receive reply from MXUDR, possibly caused by internal errors while executing user-defined routines.
-| X08P6 | -8906 | An invalid or corrupt MXUDR reply could not be processed, possibly due to memory corruption in MXUDR while executing friendly user-defined routines or an internal error in Trafodion.
+| X08P6 | -8906 | An invalid or corrupt MXUDR reply could not be processed, possibly due to memory corruption in MXUDR while executing friendly user-defined routines or an internal error in {project-name}.
| X082S | -8100 | Define <name> does not exist
| X08O4 | -8868 | Unable to create context when current transaction is implicitly started by SQL.
| X08O5 | -8869 | The specified file number is not a QFO, or the file number is not internally associated with a QFO object (CLI internal error).
@@ -2032,8 +2032,8 @@ level might result in a long compile time.
| X0DE6 | -13510 | The SQL declare section might not contain COPY or REPLACE.
| X0DE7 | -13511 | End of input file while processing EXEC SQL.
| X0DE8 | -13512 | Input file error while processing EXEC SQL.
-| X0DE9 | -13513 | The BIT data type is not implemented in Trafodion.
-| X0DEA | -13514 | The CHARACTER SET attribute is not implemented in Trafodion.
+| X0DE9 | -13513 | The BIT data type is not implemented in {project-name}.
+| X0DEA | -13514 | The CHARACTER SET attribute is not implemented in {project-name}.
| X0DEB | -13515 | Picture <name> is not valid for a host variable.
| X0DEC | -13516 | Unexpected end of input file encountered after line <num>.
| X0DED | -13517 | Line <num> is too long to process and has been truncated.
@@ -2084,16 +2084,16 @@ level might result in a long compile time.
| X0K00 | -20000 | SQL Utilities error messages.
| X0K31 | -20109 | <text>
| X0P01 | -25001 | Program <executable>, executing on <node>, has encountered a version error.
-| X0P2S | -25100 | Remote node <node> runs an incompatible version of Trafodion. The Trafodion version (version) of node is <version-1>, the local node does not support versions older than <version-2>.
-| X0P2T | -25101 | Remote node <node> runs an incompatible version of Trafodion. The Trafodion version (version) of <node> is <version-1>, the local node supports only version <version-2>.
-| X0P2U | -25102 | Remote node <node> runs a version of Trafodion which cannot interoperate with other versions. The Trafodion version (version) of <node> is <version-1>.
+| X0P2S | -25100 | Remote node <node> runs an incompatible version of {project-name}. The {project-name} version (version) of node is <version-1>, the local node does not support versions older than <version-2>.
+| X0P2T | -25101 | Remote node <node> runs an incompatible version of {project-name}. The {project-name} version (version) of <node> is <version-1>, the local node supports only version <version-2>.
+| X0P2U | -25102 | Remote node <node> runs a version of {project-name} which cannot interoperate with other versions. The {project-name} version (version) of <node> is <version-1>.
| X0P8C | -25300 | Module <module> had module version <version-1>; node <node> does not support module versions lower than <version-2>.
| X0P8D | -25301 | Module <module> had module version <version-1>; the local node does not support module versions higher than <version-2>.
| X0P8I | -25306 | A required system module has module version <version-1>; node <node> does not support query plans from modules with module version lower than <version-2>.
-| X0P8J | -25307 | The query plan can be executed only by a node with Trafodion version (version) <version-1>, the version of <node> is <version-1>.
-| X0P8K | -25308 | The query plan has plan version <version-1>, the local Trafodion version (version) can execute only query plans with plan version <version-1>.
-| X0P8L | -25309 | Module <module> can be executed only by a node with Trafodion version (version) version1, the version of <node> is <version-1>.
-| X0P8M | -25310 | Module <module> has module version <version-1>, the local Trafodion version (version) can execute modules only with module version <version-1>.
+| X0P8J | -25307 | The query plan can be executed only by a node with {project-name} version (version) <version-1>, the version of <node> is <version-1>.
+| X0P8K | -25308 | The query plan has plan version <version-1>, the local {project-name} version (version) can execute only query plans with plan version <version-1>.
+| X0P8L | -25309 | Module <module> can be executed only by a node with {project-name} version (version) version1, the version of <node> is <version-1>.
+| X0P8M | -25310 | Module <module> has module version <version-1>, the local {project-name} version (version) can execute modules only with module version <version-1>.
| X0P8N | -25311 | System module <module> has a wrong module version. The expected module version is <version-1>. The actual module version is <version-2>.
| X0U08 | -30008 | Internal error. Rowset index is out of range.
| X0U09 | -30009 | Internal error. Trying to add more elements than maximum rowset size.