Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 36EE4200C2C for ; Fri, 3 Mar 2017 09:46:04 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 35677160B6D; Fri, 3 Mar 2017 08:46:04 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 0BF29160B84 for ; Fri, 3 Mar 2017 09:46:01 +0100 (CET) Received: (qmail 94740 invoked by uid 500); 3 Mar 2017 08:46:01 -0000 Mailing-List: contact commits-help@trafodion.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: commits@trafodion.apache.org Delivered-To: mailing list commits@trafodion.apache.org Received: (qmail 94577 invoked by uid 99); 3 Mar 2017 08:46:01 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 03 Mar 2017 08:46:01 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id 33DB31A023E for ; Fri, 3 Mar 2017 08:46:00 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -7.367 X-Spam-Level: X-Spam-Status: No, score=-7.367 tagged_above=-999 required=6.31 tests=[RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-2.999, SPF_NEUTRAL=0.652] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id q4oO25OSZxK5 for ; Fri, 3 Mar 2017 08:45:45 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id DCADB60D0C for ; Fri, 3 Mar 2017 08:45:37 +0000 (UTC) Received: (qmail 89926 invoked by uid 99); 3 Mar 2017 08:44:22 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 03 Mar 2017 08:44:22 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id E448CE0A38; Fri, 3 Mar 2017 08:44:21 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sandhya@apache.org To: commits@trafodion.incubator.apache.org Date: Fri, 03 Mar 2017 08:44:38 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [18/49] incubator-trafodion-site git commit: Updates for python installer documentation in provisioning guide. archived-at: Fri, 03 Mar 2017 08:46:04 -0000 http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/be8dfc15/apidocs/2.1.0/tmudr_javadoc/apidocs/org/trafodion/sql/udr/TupleInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/2.1.0/tmudr_javadoc/apidocs/org/trafodion/sql/udr/TupleInfo.html b/apidocs/2.1.0/tmudr_javadoc/apidocs/org/trafodion/sql/udr/TupleInfo.html new file mode 100644 index 0000000..0bbcf9d --- /dev/null +++ b/apidocs/2.1.0/tmudr_javadoc/apidocs/org/trafodion/sql/udr/TupleInfo.html @@ -0,0 +1,1341 @@ + + + + + + +TupleInfo (trafodion-sql 2.1.0 API) + + + + + + + + + + + +
+
org.trafodion.sql.udr
+

Class TupleInfo

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ParameterListInfo, TableInfo
    +
    +
    +
    +
    public class TupleInfo
    +extends TMUDRSerializableObject
    +
    Common base class for parameter lists and row layouts + +

    Describes a list of scalars, which could be columns of a table + or a parameter list

    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddCharColumn(String colName, + int length, + boolean isNullable) +
      Add a fixed character output column with UTF8 charset and SYSTEM_COLLATION
      +
      voidaddCharColumn(String colName, + int length, + boolean isNullable, + TypeInfo.SQLCharsetCode charset, + TypeInfo.SQLCollationCode collation) +
      Add a fixed character output column.
      +
      voidaddColumn(ColumnInfo column) +
      Add a new column.
      +
      voidaddColumnAt(ColumnInfo column, + int position) +
      Add a new column at a specified position.
      +
      voidaddColumns(Vector<ColumnInfo> columns) +
      Add multiple columns to the table-valued output.
      +
      voidaddIntColumn(String colName, + boolean isNullable) +
      Add an integer output column.
      +
      voidaddLongColumn(String colName, + boolean isNullable) +
      Add a long output column.
      +
      voidaddVarCharColumn(String colName, + int length, + boolean isNullable) +
      Add a VARCHAR output column with UTF8 charset and SYSTEM_COLLATION
      +
      voidaddVarCharColumn(String colName, + int length, + boolean isNullable, + TypeInfo.SQLCharsetCode charset, + TypeInfo.SQLCollationCode collation) +
      Add a VARCHAR output column.
      +
      voiddeleteColumn(int i) +
      Delete a column of the table-valued output.
      +
      voiddeleteColumn(String name) +
      Delete a column with a specified column name.
      +
      booleangetBoolean(int colNum) +
      Get a boolean value of a column or parameter
      +
      booleangetBoolean(String colName) +
      Get a boolean value of a column or parameter identified by name.
      +
      intgetColNum(String colName) +
      Look up a column/parameter number by name.
      +
      ColumnInfogetColumn(int colNum) +
      Get the column info for a column identified by its ordinal.
      +
      ColumnInfogetColumn(String colName) +
      Get the column info for a column identified by its name.
      +
      StringgetDelimitedRow() +
      Get all columns of a row as a delimited string, with '|' as field delimiter
      +
      StringgetDelimitedRow(char delim, + boolean quote, + char quoteSymbol, + int firstColumn, + int lastColumn) +
      Get columns of a row as a delimited string.
      +
      doublegetDouble(int colNum) +
      Get a double value of a column or parameter + + This method is modeled after the JDBC interface.
      +
      doublegetDouble(String colName) +
      Get double value of a column/parameter identified by name.
      +
      intgetInt(int colNum) +
      Get an integer value of a column or parameter
      +
      intgetInt(String colName) +
      Get an integer value for a column identified by name.
      +
      longgetLong(int colNum) +
      Get a long value of a column or parameter
      +
      longgetLong(String colName) +
      Get a long value for a column identified by name.
      +
      intgetNumColumns() +
      Get the number of columns or parameters.
      +
      TypeInfo.SQLTypeClassCodegetSQLTypeClass(int colNum) +
      Get the SQL type class.
      +
      StringgetString(int colNum) +
      Get a string value of a column or parameter
      +
      StringgetString(String colName) +
      Get a string value of a column or parameter identified by name.
      +
      DategetTime(int colNum) +
      Get a datetime or interval column value as time_t
      +
      TypeInfogetType(int colNum) +
      Get the type of a column.
      +
      booleanisAvailable(int colNum) +
      Check whether a parameter is available at compile-time.
      +
      voidprint() +
      Print the object, for use in debugging.
      +
      voidsetDouble(int colNum, + double val) +
      Set an output column to a specified double value.
      +
      intsetFromDelimitedRow(String row) +
      Set the result row from a string with delimited field values.
      +
      intsetFromDelimitedRow(String row, + char delim, + boolean quote, + char quoteSymbol, + int firstColumnToSet, + int lastColumnToSet, + int numDelimColsToSkip) +
      Set the result row from a string with delimited field values.
      +
      voidsetInt(int colNum, + int val) +
      Set an output column to a specified integer value.
      +
      voidsetLong(int colNum, + long val) +
      Set an output column to a specified long value.
      +
      voidsetNull(int colNum) +
      Set an output column to a NULL value.
      +
      voidsetString(int colNum, + String val) +
      Set an output column to a specified string value.
      +
      voidsetTime(int colNum, + Date val) +
      Set a datetime or interval output column to a value specified as Date
      +
      booleanwasNull() +
      Check whether the last value returned from a getInt() etc.
      +
      + +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNumColumns

        +
        public int getNumColumns()
        +
        Get the number of columns or parameters.
        +
        Returns:
        Number of columns/parameters.
        +
      • +
      + + + +
        +
      • +

        getColNum

        +
        public int getColNum(String colName)
        +              throws UDRException
        +
        Look up a column/parameter number by name.
        +
        Parameters:
        colName - Name of an existing column.
        +
        Returns:
        Column/parameter number.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getColumn

        +
        public ColumnInfo getColumn(int colNum)
        +                     throws UDRException
        +
        Get the column info for a column identified by its ordinal.
        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        Column info.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getColumn

        +
        public ColumnInfo getColumn(String colName)
        +                     throws UDRException
        +
        Get the column info for a column identified by its name.
        +
        Parameters:
        colName - Name of an existing column.
        +
        Returns:
        Column info.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getType

        +
        public TypeInfo getType(int colNum)
        +                 throws UDRException
        +
        Get the type of a column.
        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        Type of the column.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getSQLTypeClass

        +
        public TypeInfo.SQLTypeClassCode getSQLTypeClass(int colNum)
        +                                          throws UDRException
        +
        Get the SQL type class. + Determine whether this is a numeric character, datetime or interval type.
        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        SQL type class enum.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getInt

        +
        public int getInt(int colNum)
        +           throws UDRException
        +
        Get an integer value of a column or parameter + +

        This method is modeled after the JDBC interface. + +

        Use this method at runtime. It can also be used for + actual parameters that are available at compile time.

        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        Integer value. + If the value was a NULL value, then 0 is returned. + The wasNull() method can be used to determine whether + a NULL value was returned.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getInt

        +
        public int getInt(String colName)
        +           throws UDRException
        +
        Get an integer value for a column identified by name.
        +
        Parameters:
        colName - Name of an existing column.
        +
        Returns:
        Integer value. + If the value was a NULL value, then 0 is returned. + The wasNull() method can be used to determine whether + a NULL value was returned.
        +
        Throws:
        +
        UDRException
        See Also:
        const
        +
      • +
      + + + +
        +
      • +

        getLong

        +
        public long getLong(int colNum)
        +             throws UDRException
        +
        Get a long value of a column or parameter + +

        This method is modeled after the JDBC interface. + +

        Use this method at runtime. It can also be used for + actual parameters that are available at compile time.

        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        long value. + If the value was a NULL value, then 0 is returned. + The wasNull() method can be used to determine whether + a NULL value was returned.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getLong

        +
        public long getLong(String colName)
        +             throws UDRException
        +
        Get a long value for a column identified by name.
        +
        Parameters:
        colName - Name of an existing column.
        +
        Returns:
        long value.
        +
        Throws:
        +
        UDRException
        See Also:
        const
        +
      • +
      + + + +
        +
      • +

        getDouble

        +
        public double getDouble(int colNum)
        +                 throws UDRException
        +
        Get a double value of a column or parameter + + This method is modeled after the JDBC interface. + + Use this method at runtime. It can also be used for + actual parameters that are available at compile time.
        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        double value.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getDouble

        +
        public double getDouble(String colName)
        +                 throws UDRException
        +
        Get double value of a column/parameter identified by name.
        +
        Parameters:
        colName - Name of an existing column.
        +
        Returns:
        double value.
        +
        Throws:
        +
        UDRException
        See Also:
        const
        +
      • +
      + + + +
        +
      • +

        getString

        +
        public String getString(int colNum)
        +                 throws UDRException
        +
        Get a string value of a column or parameter + +

        This method is modeled after the JDBC interface. + +

        Use this method at runtime. It can also be used for + actual parameters that are available at compile time.

        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        String value. + If the value was a NULL value, an empty string + is returned. The wasNull() method can be used to + determine whether a NULL value was returned.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getString

        +
        public String getString(String colName)
        +                 throws UDRException
        +
        Get a string value of a column or parameter identified by name. + +

        This method is modeled after the JDBC interface. + +

        Use this method at runtime. It cannot be used for + actual parameters that are available at compile time, use + getString(int colNum) instead, since actual parameters are not named.

        +
        Parameters:
        colName - Name of an existing column.
        +
        Returns:
        String value. + If the value was a NULL value, an empty string + is returned. The wasNull() method can be used to + determine whether a NULL value was returned.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getBoolean

        +
        public boolean getBoolean(int colNum)
        +                   throws UDRException
        +
        Get a boolean value of a column or parameter + +

        This method is modeled after the JDBC interface. + It can be used on boolean, numeric and character columns. + Numeric columns need to have a value of 0 (false) or 1 (true), + character columns need to have a value of "0" (false) or "1" (true). + +

        Use this method at runtime. It can also be used for + actual parameters that are available at compile time.

        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        Boolean value. + If the value was a NULL value, false + is returned. The wasNull() method can be used to + determine whether a NULL value was returned.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getBoolean

        +
        public boolean getBoolean(String colName)
        +                   throws UDRException
        +
        Get a boolean value of a column or parameter identified by name. + +

        This method is modeled after the JDBC interface. + It can be used on boolean, numeric and character columns. + Numeric columns need to have a value of 0 (false) or 1 (true), + character columns need to have a value of "0" (false) or "1" (true). + +

        Use this method at runtime. It cannot be used for + actual parameters that are available at compile time, use + getString(int colNum) instead, since actual parameters are not named.

        +
        Parameters:
        colName - Name of an existing column.
        +
        Returns:
        Boolean value. + If the value was a NULL value, false + is returned. The wasNull() method can be used to + determine whether a NULL value was returned.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        getTime

        +
        public Date getTime(int colNum)
        +             throws UDRException
        +
        Get a datetime or interval column value as time_t + +

        This method can be used to convert column values with + a datetime type or a day-second interval type to the + POSIX type time_t. Note that this may result in the loss + of fractional seconds. + +

        Use this method at runtime. It can also be used for + actual parameters that are available at compile time.

        +
        Parameters:
        colNum - Column number.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        isAvailable

        +
        public boolean isAvailable(int colNum)
        +                    throws UDRException
        +
        Check whether a parameter is available at compile-time. + +

        Use this method to check in the compiler interfaces whether + an actual parameter is a constant value that can be read + at compile time. If this method returns true, the value + can be accessed with the getInt(), getString() etc. methods.

        +
        Parameters:
        colNum - Column number.
        +
        Returns:
        true if the parameter value is available.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        wasNull

        +
        public boolean wasNull()
        +
        Check whether the last value returned from a getInt() etc. method was NULL. + +

        This method is modeled after the JDBC interface.

        +
        Returns:
        true if the last value returned from a getInt(), getString() + etc. method was a NULL value, false otherwise.
        +
      • +
      + + + +
        +
      • +

        setInt

        +
        public void setInt(int colNum,
        +          int val)
        +            throws UDRException
        +
        Set an output column to a specified integer value. + +

        Use this method at runtime.

        +
        Parameters:
        colNum - Index/ordinal of the column to set.
        val - The new integer value for the column to set.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        setLong

        +
        public void setLong(int colNum,
        +           long val)
        +             throws UDRException
        +
        Set an output column to a specified long value. + +

        Use this method at runtime.

        +
        Parameters:
        colNum - Index/ordinal of the column to set.
        val - The new long value for the column to set.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        setDouble

        +
        public void setDouble(int colNum,
        +             double val)
        +               throws UDRException
        +
        Set an output column to a specified double value. + +

        Use this method at runtime.

        +
        Parameters:
        colNum - Index/ordinal of the column to set.
        val - The new double value for the column to set.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        setString

        +
        public void setString(int colNum,
        +             String val)
        +               throws UDRException
        +
        Set an output column to a specified string value. + +

        Use this method at runtime.

        +
        Parameters:
        colNum - Index/ordinal of the column to set.
        val - The new string value for the column to set.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        setTime

        +
        public void setTime(int colNum,
        +           Date val)
        +             throws UDRException
        +
        Set a datetime or interval output column to a value specified as Date + +

        This method cannot be used with year-month intervals or data types that + are not datetime or interval types. It is not possible to set fractional + seconds with this method. + +

        Use this method at runtime.

        +
        Parameters:
        colNum - Index/ordinal of the column to set.
        val - The new Date value for the column to set.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        setFromDelimitedRow

        +
        public int setFromDelimitedRow(String row,
        +                      char delim,
        +                      boolean quote,
        +                      char quoteSymbol,
        +                      int firstColumnToSet,
        +                      int lastColumnToSet,
        +                      int numDelimColsToSkip)
        +                        throws UDRException
        +
        Set the result row from a string with delimited field values. + +

        This method can be used to read delimited text files and + conveniently produce a result table from them. For example, + if the following string is passed in as row:

        +
        Parameters:
        row - A string with delimited field values to read.
        delim - Delimiter between field values. Use a US ASCII symbol + as the delimiter.
        quote - true if the method should assume that text fields + use quotes to quote special symbols like delimiters + that are embedded within fields, and that quote symbols + embedded in text fields will be doubled.
        quoteSymbol - US ASCII Quote symbol used to quote text. Meaningful + only if quote is set to true.
        firstColumnToSet - First column in the output table to be set + from the delimited row (0-based).
        lastColumnToSet - Last column in the output table to be set + (inclusive) or -1 to indicate to set all + remaining columns of the table.
        numDelimColsToSkip - Number of fields to skip in the delimited + row before using the values to set output + columns.
        +
        Returns:
        Number of character read from row. Can be used + to process text that is not yet consumed.
        +
        Throws:
        +
        UDRException
        See Also:
        getDelimitedRow(char,boolean,char,int,int)
        +
      • +
      + + + +
        +
      • +

        setFromDelimitedRow

        +
        public int setFromDelimitedRow(String row)
        +                        throws UDRException
        +
        Set the result row from a string with delimited field values. + +

        Calls other version of setFromDelimitedRow with these arguments

        +
        Parameters:
        row - A string with delimited field values to read.
        +
        Returns:
        Number of character read from row. Can be used + to process text that is not yet consumed.
        +
        Throws:
        +
        UDRException
        See Also:
        getDelimitedRow( )
        +
      • +
      + + + +
        +
      • +

        setNull

        +
        public void setNull(int colNum)
        +             throws UDRException
        +
        Set an output column to a NULL value. + +

        Use this method at runtime.

        +
        Parameters:
        colNum - Index/ordinal of the column to set to NULL.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        addColumn

        +
        public void addColumn(ColumnInfo column)
        +
        Add a new column. + + Only use this method from within the following method: +
          +
        • UDR::describeParamsAndColumns() +
        +
        Parameters:
        column - Info of the new column to add.
        +
      • +
      + + + +
        +
      • +

        addIntColumn

        +
        public void addIntColumn(String colName,
        +                boolean isNullable)
        +                  throws UDRException
        +
        Add an integer output column. + +

        The new column is added at the end. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        colName - Name of the column to add. Use UPPER CASE letters, + digits and underscore, otherwise you will need to + use delimited column names with matching case in + Trafodion.
        isNullable - true if the added column should be nullable, + false if the added column should have the NOT NULL + constraint.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        addLongColumn

        +
        public void addLongColumn(String colName,
        +                 boolean isNullable)
        +                   throws UDRException
        +
        Add a long output column. + +

        The new column is added at the end. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        colName - Name of the column to add. Use UPPER CASE letters, + digits and underscore, otherwise you will need to + use delimited column names with matching case in + Trafodion.
        isNullable - true if the added column should be nullable, + false if the added column should have the NOT NULL + constraint.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        addCharColumn

        +
        public void addCharColumn(String colName,
        +                 int length,
        +                 boolean isNullable,
        +                 TypeInfo.SQLCharsetCode charset,
        +                 TypeInfo.SQLCollationCode collation)
        +                   throws UDRException
        +
        Add a fixed character output column. + +

        The new column is added at the end. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        colName - Name of the column to add. Use UPPER CASE letters, + digits and underscore, otherwise you will need to + use delimited column names with matching case in + Trafodion.
        length - Length of the new character column. + For single-byte and variable byte character sets, + the length is specified in bytes. For UTF-8, this + is equivalent to CHAR(length BYTES) in SQL. For UCS2, + the length is in UCS2 16-bit characters.
        isNullable - true if the added column should be nullable, + false if the added column should have the NOT NULL + constraint.
        charset - Character set of the new column.
        collation - Collation of the new column.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        addCharColumn

        +
        public void addCharColumn(String colName,
        +                 int length,
        +                 boolean isNullable)
        +                   throws UDRException
        +
        Add a fixed character output column with UTF8 charset and SYSTEM_COLLATION + +

        The new column is added at the end. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        colName - Name of the column to add. Use UPPER CASE letters, + digits and underscore, otherwise you will need to + use delimited column names with matching case in + Trafodion.
        length - Length of the new character column. + For single-byte and variable byte character sets, + the length is specified in bytes. For UTF-8, this + is equivalent to CHAR(length BYTES) in SQL. For UCS2, + the length is in UCS2 16-bit characters.
        isNullable - true if the added column should be nullable, + false if the added column should have the NOT NULL + constraint.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        addVarCharColumn

        +
        public void addVarCharColumn(String colName,
        +                    int length,
        +                    boolean isNullable,
        +                    TypeInfo.SQLCharsetCode charset,
        +                    TypeInfo.SQLCollationCode collation)
        +                      throws UDRException
        +
        Add a VARCHAR output column. + +

        The new column is added at the end. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        colName - Name of the column to add. Use UPPER CASE letters, + digits and underscore, otherwise you will need to + use delimited column names with matching case in + Trafodion.
        length - Length of the new character column. + For single-byte and variable byte character sets, + the length is specified in bytes. For UTF-8, this + is equivalent to CHAR(length BYTES) in SQL. For UCS2, + the length is in UCS2 16-bit characters.
        isNullable - true if the added column should be nullable, + false if the added column should have the NOT NULL + constraint.
        charset - Character set of the new column.
        collation - Collation of the new column.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        addVarCharColumn

        +
        public void addVarCharColumn(String colName,
        +                    int length,
        +                    boolean isNullable)
        +                      throws UDRException
        +
        Add a VARCHAR output column with UTF8 charset and SYSTEM_COLLATION + +

        The new column is added at the end. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        colName - Name of the column to add. Use UPPER CASE letters, + digits and underscore, otherwise you will need to + use delimited column names with matching case in + Trafodion.
        length - Length of the new character column. + For single-byte and variable byte character sets, + the length is specified in bytes. For UTF-8, this + is equivalent to CHAR(length BYTES) in SQL. For UCS2, + the length is in UCS2 16-bit characters.
        isNullable - true if the added column should be nullable, + false if the added column should have the NOT NULL + constraint.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        addColumns

        +
        public void addColumns(Vector<ColumnInfo> columns)
        +
        Add multiple columns to the table-valued output. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        columns - Vector of ColumnInfo objects describing the columns to add.
        +
      • +
      + + + +
        +
      • +

        addColumnAt

        +
        public void addColumnAt(ColumnInfo column,
        +               int position)
        +
        Add a new column at a specified position. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        column - ColumnInfo object describing the new column.
        position - Position/ordinal number of the new column. + All existing columns with ordinal numbers + greater or equal to position will be shifted by one.
        +
      • +
      + + + +
        +
      • +

        deleteColumn

        +
        public void deleteColumn(int i)
        +                  throws UDRException
        +
        Delete a column of the table-valued output. + +

        Only use this method from within the + UDR#describeParamsAndColumns() method.

        +
        Parameters:
        i - Position/ordinal (0-based) of column to be deleted.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + +
        +
      • +

        deleteColumn

        +
        public void deleteColumn(String name)
        +                  throws UDRException
        +
        Delete a column with a specified column name. + +

        The first column that matches the specified column name + will be deleted.

        +
        Parameters:
        name - Name of the column to be deleted.
        +
        Throws:
        +
        UDRException
        +
      • +
      + + + + +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2017. All rights reserved.

+ +