4 Documentation Addendum

This section contains corrections to the following Oracle Documentation for this release:

Section 4.1, "Oracle Automatic Storage Management Administrator's Guide"

Section 4.2, "Oracle Clusterware Administration and Deployment Guide"

Section 4.3, "Oracle Database Administrator's Guide"

Section 4.4, "Oracle Database JDBC Java API Reference"

Section 4.5, "Oracle Database Net Services Reference"

Section 4.6, "Oracle Database New Features Guide"

Section 4.7, "Oracle Database PL/SQL Packages and Types Reference"

Section 4.8, "Oracle Database Utilities"

Section 4.9, "Oracle Database VLDB and Partitioning Guide"

Section 4.10, "Oracle Real Application Clusters Administration and Deployment Guide"

Section 4.11, "Oracle Text Application Developer's Guide"

Section 4.12, "Oracle Text Reference"

4.1 Oracle Automatic Storage Management Administrator's Guide

Note the following changes with regard to the Oracle Automatic Storage Management Administrator's Guide.

4.1.1 Specifying Unprotected Redundancy

In the section "volcreate" under "ASMCMD Volume Management Commands," the following warning applies:

WARNING:

Specifying --redundancy unprotected means that Oracle ASM mirroring is not available for data recovery with the Oracle ADVM volume. The redundancy setting (normal) of the disk group does not provide mirroring for an unprotected Oracle ADVM volume. The unprotected configuration is not recommended for production environments as intermittent storage access failures can result in the loss of data. Backups are strongly recommended.

4.1.2 Extended Partition Tables Are Not Supported

Extended partition tables are not supported with Oracle ASM filter driver (ASMFD) in Oracle Automatic Storage Management 12.1.

4.2 Oracle Clusterware Administration and Deployment Guide

Note the following changes with regard to the Oracle Clusterware Administration and Deployment Guide.

4.2.1 Database Checks

In Appendix A, the section titled "cluvfy comp healthcheck", the text indicates that you must create a user CVUSYS using a script to make the database checks work. This is incorrect. You must create a user DBSNMP (using uppercase characters) to make the database checks work.

4.2.2 Changing the GNS Subdomain

In Chapter 2, the section titled "Administering Grid Naming Service", the procedure was not documented regarding how to change the Grid Naming Service (GNS) subdomain when moving from an IPv4 network to an IPv6 network. The steps are:

  1. Add an IPv6 subnet using the SRVCTL modify network command.

    srvctl modify network ¿subnet ipv6_subnet/
       ipv6_prefix_length[/interface] -nettype autoconfig
    
  2. Update the GNS domain.

    srvctl stop gns -f
    srvctl stop scan -f
    srvctl remove gns -f
    srvctl add gns -vip gns_vip -domain gns_subdomain
    srvctl start gns
    
  3. Update the Single Client Access Name (SCAN) with a new domain.

    srvctl remove scan -f
    srvctl add scan -scanname new_domain
    srvctl start scan
    
  4. Convert the network IP type from IPv4 to both IPv4 DHCP and IPv6 autoconfig.

    srvctl modify network -iptype both
    
  5. Transition the network from using both protocols to using only IPv6 autoconfig using the following command:

    srvctl modify network -iptype ipv6
    

4.2.3 OCRCONFIG Utility

In Appendix I, in the section titled "About OCRCONFIG", Log Files, the correct text should be:

The OCRCONFIG utility creates a log file in <GI ORACLE_BASE>/diag/crs/<host>/crs.

To change the amount of logging, edit the path in the <GI ORACLE_BASE>/crsdata/<host>/crsdiag/<program>.ini file (for example, ocrconfig.ini).

Similar changes also apply to the last paragraph of the section titled "Using the OCRCHECK Utility" and the third paragraph of the section titled "Using the OCRDUMP Utility to View Oracle Cluster Registry Content" in Appendix I.

4.2.4 Deleting a Cluster Node

In Chapter 7, in the section titled "Deleting a Cluster Node on Linux and UNIX Systems", add the following as Steps 9 (or 7) and 10 (or 8):

Step 9 (or 7): After deleting the node where the CRS daemon is down, check if the vip for the deleted node still exists using the following command:

srvctl config vip -node deleted_node

Step 10 (or 8): Remove the vip if it still exists using the following commands:

srvctl stop vip -node deleted_node
srvctl remove vip -node deleted_node -f

Also in Chapter 7, in the section titled "Deleting a Cluster Node on Windows Systems", add the same steps as Steps 7 and 8.

4.2.5 Adding a Node to a Cluster on Windows Systems

Step 4 in the section titled "Adding a Node to a Cluster on Windows Systems" in Chapter 7 must be changed to:

C:\> ORACLE_HOME/bin/srvctl stop instance -node newly_added_node_name

4.2.6 Deleting a Rapid Home Provisioning Client

In the Chapter titled "Rapid Home Provisioning," a section with the following text describing how to delete a Rapid Home Provisioning Client should be added:

To delete a Rapid Home Provisioning Client, execute the following steps:

  1. On the Rapid Home Provisioning Server:

    1. To query the list of working copies that have been provisioned on the Rapid Home Provisioning Client cluster, execute the following command:

      $ rhpctl query workingcopy -client <client_name>
      
    2. For each of the working copies listed in the output of the command in Step 1.a, execute the following command:

      $ rhpctl delete workingcopy -workingcopy <workingcopy_name>
      
    3. To query the list of users from the Rapid Home Provisioning Client cluster, execute the following command:

      $ rhpctl query user -client <client_name>
      
    4. To delete the user listed in the output of the command in Step 1.c, execute the following command:

      $ rhpctl delete user -user <username> -client <client_name>
      
  2. On the Rapid Home Provisioning Client cluster, execute the following:

    1. Stop the Rapid Home Provisioning Client daemon with the following command:

      $ srvctl stop rhpclient
      
    2. Delete the Rapid Home Provisioning Client configuration using the following command:

      $ srvctl remove rhpclient
      
  3. On the Rapid Home Provisioning Server cluster, execute the following command to delete the client site configuration:

    $ rhpctl delete client -client <client_name>
    

4.2.7 cluvfy comp cfs Command is Deprecated

The cluvfy comp cfs command is deprecated in release 12.1.0.2. In previous releases, you used cluvfy comp cfs component verification command to check the integrity of a clustered file system (OCFS2)

4.2.8 Automatically Manage Restart Attempts Counter for Resources

In Chapter 9, the section titled "Automatically Manage Restart Attempts Counter for Resources", replace the first three lines with the following:

When a resource fails, Oracle Clusterware attempts to restart the resource the number of times specified in the RESTART_ATTEMPTS resource attribute. Note that this attribute does not specify the number of attempts to restart a failed resource (always one attempt), but rather the number of times the resource fails locally, before the Clusterware attempts to fail it over. The CRSD process maintains an internal counter to track how often Oracle Clusterware restarts a resource. The number of times Oracle Clusterware has restarted a resource locally is reflected in the RESTART_COUNT resource attribute.

4.2.9 Table: FILESYSTEMS View Metric Descriptions

In Appendix J, the table titled "FILESYSTEMS View Metric Descriptions" in the section titled "OCLUMON Command Reference", add the following entries:

Metric Description
name Name of the file system
mount Mount point where the file system is mounted
type Type of the file system that is mounted, whether it is Local or NTFS or EXT2
mft% Percentage of master file table utilization

4.3 Oracle Database Administrator's Guide

Note the following changes with regard to the Oracle Database Administrator's Guide.

4.3.1 -force Option is Not Implemented With the remove service Command

You can ignore references to the -force option with regard to the SRVCTL remove service command. The -force option is not implemented with the remove service command.

4.4 Oracle Database JDBC Java API Reference

Starting Oracle Database 11gR2, JDBC clients can use OracleDriver to establish connections to a database from a java application.

Registering the JDBC drivers is no longer a prerequisite.

4.5 Oracle Database Net Services Reference

Note the following changes with regard to the Oracle Database Net Services Reference, 12c Release 1 (12.1), part number E17611.

4.5.1 Chapter 5: Parameters for the sqlnet.ora File

In the sub-section titled "TCP.VALIDNODE_CHECKING" in the section titled "sqlnet.ora Profile Parameters", the following paragraphs need to be added to the Usage Notes:

This parameter and the depending parameters, TCP.INVITED_NODES and TCP.EXCLUDED_NODES must be set in the sqlnet.ora file of the listener. This is important in an Oracle RAC environment where the listener runs out of the Oracle Grid Infrastructure home. Setting the parameter in the database home does not have any effect in Oracle RAC environments. In such environments, the address of all Single Client Access Name (SCANs), Virtual IPs (VIPs), local IP must be included in the TCP.INVITED_NODES list.

In VLAN environments, the sqlnet.ora file present in the Oracle Grid Infrastructure home should include all the addresses of all the VLANs. The VLANs perform the network segregation, whereas the INVITED_NODES allows or restricts access to databases within the VLANs.

If multiple databases within the same VLAN require different INVITED_NODE lists, then separate listeners are required.

4.5.2 Chapter 7: Oracle Net Listener Parameters in the listener.ora File

In the sub-section titled "Control Parameters", the following section should be added:

SSL_VERSION

Purpose

To limit allowable SSL or TLS versions used for connections.

Usage Notes

Clients and database servers must use a compatible version. This parameter should only be used when absolutely necessary for backward compatibility. The current default uses TLS version 1.2 which is the version required for multiple security compliance requirements.

Default

1.2

Values

undetermined | 3.0 | 1.0| 1.1 | 1.2

If you want to specify one version or another version, then use ”or”. The following values are permitted:

1.0 or 3.0 | 1.2 or 3.0 | 1.1 or 1.0 | 1.2 or 1.0 | 1.2 or 1.1 | 1.1 or 1.0 or 3.0 |

1.2 or 1.0 or 3.0 | 1.2 or 1.1 or 1.0 | 1.2 or 1.1 or 3.0 | 1.2 or 1.1 or 1.0 or 3.0

Example

SSL_VERSION=1.2

The remaining version numbers correspond to the TLS versions, such as, TLSv1.0, TLSv1.1, and TLSv1.2.

4.5.3 Chapter 8: Oracle Connection Manager Parameters (cman.ora)

In the sub-section titled "INBOUND_CONNECT_TIMEOUT" in the section titled "Oracle Connection Manager Parameters", the first bullet under Values must read as follows:

  • 60 secs is the default. Use value 0 to disable timeout.

4.5.4 RECV_BUF_SIZE Parameter

In Chapter 6, the sub-section titled "RECV_BUF_SIZE" in the section titled "Optional Parameters for Address Lists", the documented default value for the RECV_BUF_SIZE parameter is incorrect. The correct default for Linux 2.6 operating system is 87380 bytes.

In Chapter 7, the sub-section titled "RECV_BUF_SIZE" in the section titled "Protocol Address Parameters", the documented default value for the RECV_BUF_SIZE parameter is incorrect. The correct default for Linux 2.6 operating system is 87380 bytes.

4.5.5 SQLNET.EXPIRE_TIME Parameter

In Chapter 5, the section titled "SQLNET.EXPIRE_TIME", add the following point as a limitation in the Usage Notes:

  • The use of SQLNET.EXPIRE_TIME with TCPS is unsupported.

4.6 Oracle Database New Features Guide

In the Oracle Database New Features Guide, part number E17906-16, the section titled "New Predefined PL/SQL Inquiry Directives" incorrectly documented the name of two inquiry directives available in Oracle Database 12c Release 1 (12.1). The $$PLSQL_OWNER and $$PLSQL_TYPE inquiry directives should be $$PLSQL_UNIT_OWNER and $$PLSQL_UNIT_TYPE.

4.7 Oracle Database PL/SQL Packages and Types Reference

The listno parameter of the DBMS_UTILITY was inadvertently excluded from the Oracle Database PL/SQL Packages and Types Reference. For example, the GET_PARAMETER_VALUE function should read as follows:

GET_PARAMETER_VALUE Function

This function gets the value of specified initialization parameter.

Syntax

DBMS_UTILITY.GET_PARAMETER_VALUE (
    parnam       IN        VARCHAR2,
    intval       IN OUT    BINARY_INTEGER,
    strval       IN OUT    VARCHAR2,
    listno       IN        BINARY_INTEGER DEFAULT 1)
  RETURN BINARY_INTEGER;

Parameters

Parameter Description
parnam Parameter name.
intval Value of an integer parameter or the value length of a string parameter.
strval Value of a string parameter.
listno List item number. If retrieving parameter values for a parameter that can be specified multiple times to accumulate values, use this parameter to get each individual parameter.

4.8 Oracle Database Utilities

Note the following with regard to Oracle Database Utilities, 12c Release 1 (12.1), part number E41528.

4.8.1 Chapter 18: DBVERIFY: Offline Database Verification Utility

In the sub-section titled "DBVERIFY Parameters When Validating Blocks of a Single File" in the section titled "Using DBVERIFY to Validate Disk Blocks of a Single Data File", the description for the USERID parameter must read as follows:

Specifies your username and password. This parameter is not necessary for Oracle ASM files.

4.9 Oracle Database VLDB and Partitioning Guide

Note the following changes in Oracle Database VLDB and Partitioning Guide:

  • It was incorrectly documented that interval partitioning was supported with XMLIndex. XMLIndex only supports range, list, and hash partitioning with schemes.

  • Deferred segment creation does not apply for subpartitions of a composite interval partitioned table. When an interval partition is created, all subpartitions are materialized.

4.10 Oracle Real Application Clusters Administration and Deployment Guide

Note the following changes with regard to the Oracle Real Application Clusters Administration and Deployment Guide.

4.10.1 Restricted Service Registration

In Chapter 5, the section titled "Restricted Service Registration", a note should be added with the following information:

The save_config command cannot make the settings of the valid node checking for registration (VNCR) parameter to persist.

4.10.2 Database Fails to Start After Using a New Private NIC

In the Appendix titled "Troubleshooting Oracle RAC", the following section should be added:

Database Fails to Start After Using a New Private NIC

After installing Oracle Clusterware and Oracle Flex ASM, when a new private network interface card (NIC) that was added is used, the database fails to start the ora.storage resource. Manually update the listener after adding the new NIC for Oracle Flex ASM.

4.10.3 Stopping Instances and Services

In Appendix A, the section titled "srvctl stop instance", the paragraph and the syntax should read as follows:

The srvctl stop instance command stops instances and stops any services running on specified instances.

Syntax

srvctl stop instance -db db_unique_name {-node node_name
    | -instance "instance_name_list"} [-stopoption stop_options] [-force] [-failover]

Parameters

-failover
 
-force

If you specify -failover, then the services fail over to an available instance when the instance stops.

-force is required only to forcibly stop the instance and any running services if the stop instance command fails with an error.

4.10.4 Overview of In-Memory Column Store with Oracle RAC

In the section titled "Overview of In-Memory Column Store with Oracle RAC", the paragraph that begins with "On an Engineered System an object ..." needs to be changed to read as follows:

On an Engineered System, it is possible to duplicate or mirror objects populated in memory across the In-Memory Column Store (IM column store) in the cluster. This provides the highest level of redundancy. The DUPLICATE clause is used to control how an object should be duplicated across the IM column stores in the cluster. If you specify just DUPLICATE, then one mirrored copy of the data is distributed across the IM column stores in the cluster. If you want to duplicate the entire object in each IM column store in the cluster, specify DUPLICATE ALL.

4.10.5 Converting Databases to Oracle RAC Using Oracle Enterprise Manager

In Chapter 14, the section titled "Converting Databases to Oracle RAC Using Oracle Enterprise Manager", remove step 4 and replace step 3 with the following:

3. On the Database home page, from the Availability menu, select Convert to Cluster Database.

4.10.6 Starting and Stopping Listeners

In Appendix A, the sections titled "srvctl start listener" and "srvctl stop listener", the following text is incorrect in the tables:

"If you do not specify this parameter, then the listener name defaults to LISTENER for a database listener; LISTENER_ASM for an Oracle ASM listener; or LISTENER_LEAF for a Leaf Node listener."

  • The correct text for "srvctl start listener" should be:

    "If you do not specify this parameter, then all the known listeners are started."

  • The correct text for "srvctl stop listener" should be:

    "If you do not specify this parameter, then all the known listeners are stopped."

4.11 Oracle Text Application Developer's Guide

Note the following changes with regard to Oracle Text Application Developer's Guide, 12c Release 1 (12.1), part number E41398.

4.11.1 Chapter 11: Using XML Query Result Set Interface

The first paragraph in the section titled "Using the XML Query Result Set Interface" should be changed to read:

The CTX_QUERY.RESULT_SET() and CTX_QUERY.RESULT_SET_CLOB_QUERY() APIs enable you to obtain query results with a single query, rather than running multiple CONTAINS() queries to achieve the same result. The two APIs are identical except that one uses a VARCHAR2 query parameter, and the other uses a CLOB query parameter to allow for longer queries.

4.12 Oracle Text Reference

Note the following changes with regard to Oracle Text Reference, 12c Release 1 (12.1), part number E41399.

4.12.1 Chapter 1: Oracle Text SQL Statements and Operators

Note the following changes:

  • In the sub-section titled "Notes" under the main section titled "ALTER INDEX", the following item should be documented in the bulleted list:

    • You cannot have embedded blanks in section and field names.

    According to Bug 21330358, field names cannot use embedded blanks. For example, my section is an invalid section name since there is a blank just after my. This applies to field names that are defined using "".

  • Although the ALTER INDEX OPTIMIZE operation for Text Indexes was desupported in Oracle Database 12c Release 1 (12.1), it was not removed from the Oracle Text Reference document.

4.12.2 Chapter 2: Oracle Text Indexing Elements

This chapter should include the following section:

Token Limitations

All Oracle Text index types store tokens in a table column of type VARCHAR2 (64 BYTE). This means that the maximum size of an indexed token is 64 characters for single–byte character sets, and is less with multibyte or variable-length character sets. Any longer tokens are truncated at 64 bytes. That does not mean that the token cannot be searched for, but rather that the system cannot distinguish between the two tokens which have the same first 64 bytes.

4.12.3 Chapter 8: CTX_DDL Package

For the ADD_STOPCLASS procedure, English is the only language supported for stopclasses.

4.12.4 Chapter 9: CTX_DOC Package

In the Syntax 1 and Syntax 2 examples for the POLICY_SNIPPET and SNIPPET procedures, the default value for max_length is 150 and not 250.

4.12.5 Chapter 12: CTX_QUERY Package

This chapter should contain the following new section:

RESULT_SET_CLOB_QUERY

This procedure executes an XML query and generates a result set based on a CLOB query parameter in XML.

The RESULT_SET_CLOB_QUERY procedure is identical to the RESULT_SET procedure except that the data type of its query parameter is CLOB instead of VARCHAR2 to handle longer queries.

Syntax

CTX_QUERY.RESULT_SET_CLOB_QUERY (
   index_name            IN VARCHAR2,
   query                 IN CLOB,
   result_set_descriptor IN CLOB,
   result_set            IN OUT CLOB,
   part_name             IN VARCHAR2 DEFAULT 
);

4.12.6 Appendix B: Section: Oracle Text Supported Document Formats

In Appendix B titled "Oracle Text Supported Document Formats", Oracle Text does not extract text for the following file formats:

  • IBM Lotus Notes NSF (File ID) 7.x, 8.x

  • IBM Lotus Notes NSF (Windows, Linux x86-32 and Oracle Solaris 32-bit only with Notes Client or Domino Server) 8.x