Send feedback on this topic.
Teradata.Client.Provider
TdIntervalMonth Structure
Members  Example 



Teradata.Client.Provider Namespace : TdIntervalMonth Structure
TdIntervalMonth represents an interval of time defining a duration in months. The month precision is configurable from 1 - 4 significant digits.
Object Model
TdIntervalMonth StructureTdIntervalMonth StructureTdIntervalMonth StructureTdIntervalMonth StructureTdIntervalMonth StructureTdIntervalMonth Structure
Syntax
Remarks

TdIntervalMonth is a .NET Data Provider for Teradata specific type, designed to support a SQL Interval Month data type.

The TdIntervalMonth supports the Teradata Interval Month (precision) data type where precision indicates the number of digits in the months (from 1 - 4).

The interval value must be specified in the following format :

[sign][months]

Format Element Description
sign Optional - or space character.
months Required number of months (one to four digits in length).

.NET does not have a system type that directly corresponds to the SQL Interval Month data type. The .NET Data Provider for Teradata Version 13.0 version and prior versions map Interval Month to System.String. With version 13.1 of the provider, TdIntervalMonth is available to retrieve and manipulate data of type Interval Month.

The range of values for each TdInterval precision is as follows:

Type and Precision Minimum Maximum
TdIntervalMonth(1)

-'9'

'9'
TdIntervalMonth(2)

-'99'

'99'
TdIntervalMonth(3)

-'999'

'999'
TdIntervalMonth(4)

-'9999'

'9999'

TdIntervalMonth also supports TdIntervalMonth.Null. This is a very important feature. An application is no longer required to call TdDataReader.IsDBNull before invoking the corresponding TdDataReader "Get" method. This will improve overall performance.

A TdIntervalMonth structure allows arithmetic, comparision and conversion operations to be performed.

A TdIntervalMonth may also be specified as an in, out, or in/out parameter to a stored procedure. In order to maintain backward compatibility with previous versions of the provider (release 13.0 and prior), a Connection String Attribute TdConnectionStringBuilder.EnableTdIntervals has been added. When the EnableTdIntervals attribute is true, TdParameter.ProviderSpecificValue will return the data as the provider specific type of TdIntervalMonth. When EnableTdIntervals is false, TdParameter.ProviderSpecificValue will return the data as a .NET Framework Library data type of String.

The TdParameter.Value will return the .NET Framework Library data type of System.String whether EnableTdIntervals is true or false.

For more information on the Teradata Interval Month data type please see the 'SQL Data Types and Literals' manual.

Example

The following example shows how to retrieve a TdIntervalMonth, modify the interval, and then update the table.

Public void TimeExample(TdCommand cmd, String model)
{
   cmd.Parameters.Clear();
   
   cmd.CommandText = "SELECT StartDate, LeaseLen FROM AutoLeases " +
                     "WHERE Model = ?";
             
   cmd.CommandType = CommandType.Text;
             
   cmd.Parameters.Add(null, TdType.VarChar, 10,
        ParameterDirection.Input, true, 0, 0, null,    
        DataRowVersion.Default, model);
             
   Int32 row = 0;
   TdDate [] startDate;
   TdIntervalYearToMonth [] leaseLen;
             
   using (TdDataReader dr = cmd.ExecuteReader())
   { 
      TdDate [] startDate = new TdDate[dr.RecordsReturned];
      TdIntervalMonth [] leaseLen = new TdIntervalMonth [dr.RecordsReturned];
             
      // Specifying an interval of 2 years with a precision of 2
      TdIntervalMonth twoExtraYears = new TdIntervalMonth(24, 2);
   
      while (dr.Read())
      {
         // Retrieving the dates
         startDate[row] = dr.GetTdDate(0);
         leaseLen[row] = dr.GetTdIntervalMonth(1);
             
         // Adding 2 years to the StartDate
         startDate[row] = startDate[row] + twoExtraYears;
             
         // Adding 2 years to the lease length;
         leaseLen[row] = leaseLen[row] + twoExtraYears;
             
         row++;
      } 
   }
   cmd.Parameters.Clear();
             
   cmd.CommandText = "UPDATE AutoLeases " +
                     "SET StartDate = ?, LeaseLen = ? " +
                     "WHERE Model = ?";
             
   cmd.Parameters.Add(null, TdType.Date, 0,
         ParameterDirection.Input, true, 0, 0, null,    
         DataRowVersion.Default, null);
             
   cmd.Parameters.Add(null, TdType.IntervalMonth, 0,
         ParameterDirection.Input, true, 0, 0, null,    
         DataRowVersion.Default, null);
             
   cmd.Parameters.Add(null, TdType.VarChar, 9,
         ParameterDirection.Input, true, 0, 0, null,    
         DataRowVersion.Default, model);
             
   row--;
   while(row >= 0)
   {
      cmd.Parameters[0].Value = startDate[row];
      cmd.Parameters[1].Value = leaseLen[row];
             
      cmd.ExecuteNonQuery();
      row--;
   }
}
Inheritance Hierarchy

System.Object
   System.ValueType
      Teradata.Client.Provider.TdIntervalMonth

Requirements

Target Platforms: Windows 8.1, Windows 10, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019

See Also

Reference

TdIntervalMonth Members
Teradata.Client.Provider Namespace
EnableTdIntervals Property
Interval Connection String Attribute
Enabling Provider Specific Types
Provider Specific Type: Interval Type Overview