Oracle Supplied Packages, 4 of 4

Subprograms in Supplemental Packages

The packages listed in the remainder of this chapter are primarily documented in other Oracle books. This section lists the subprograms provided with each of these packages. Please refer to the above table for the cross-reference to the full documentation.

Calendar

Table 1-2 Calendar Package Subprograms

Subprograms	Description
CombineCals	Combines two calendars.
Day	Creates a calendar with a frequency of day.
DeleteExceptions	Deletes from the specified calendar all exceptions that either match a specified date (`delExcDate`) or are included in a table of dates (`delExcTab`), and returns the resulting calendar.
DisplayValCal	Displays the results returned by the `ValidateCal` function.
EqualCals	Checks if two calendars are equal.
GenDateRangeTab	Returns a table of date ranges that represent all of the valid intervals in the input calendar (or from the `startDate` through `endDate` parameters).
GetIntervalEnd	Returns the end of the interval that includes the input timestamp.
GetIntervalStart	Returns the start of the interval that includes the input timestamp.
GetOffset	Returns the number of timestamps that the second date is offset from the first.
Hour	Creates a calendar with a frequency of hour.
InsertExceptions	Inserts into the specified calendar all exceptions that either match a specified date (`newExcDate`) or are included in a table of dates (`newExcTab`), and returns the resulting calendar.
IntersectCals	Returns the intersection of two calendars.
InvalidTimeStamps Between	Returns a table (`ORDTDateTab`) containing the invalid timestamps within that range according to the specified calendar.
IsValidCal	Returns 1 if the calendar is valid and 0 if the calendar is not valid.
IsValidDate	Checks whether an input date is valid or invalid according to the specified calendar.
Minute	Creates a calendar with a frequency of minute.
Month	Creates a calendar with a frequency of month.
NumInvalidTimeStamps Between	Returns the number of invalid timestamps within that range according to the specified calendar.
NumOffExceptions	Returns the number of off-exceptions within that range according to the specified calendar.
NumOnExceptions	Returns the number of on-exceptions within that range according to the specified calendar.
NumTimeStampsBetween	Returns the number of valid timestamps within that range according to the specified calendar.
OffsetDate	Returns the timestamp corresponding to the offset input.
Quarter	Creates a calendar with a frequency of quarter.
Second	Creates a calendar with a frequency of second.
Semi_annual	Creates a calendar with a frequency of semi-annual.
Semi_monthly	Creates a calendar with a frequency of semi-monthly.
SetPrecision	Returns a timestamp that reflects the level of precision implied by the frequency of the specified calendar.
Ten_day	Creates a calendar with a frequency of 10-day.
TimeStampsBetween	Returns a table (`ORDTDateTab`) containing the valid timestamps within that range according to the specified calendar.
UnionCals	Returns a calendar that is the union of two input calendars.
ValidateCal	Validates a calendar and, if necessary, repairs the calendar and outputs information related to the problems and repairs.
Week	Creates a calendar with a frequency of week.
Year	Creates a calendar with a frequency of year.

SDO_ADMIN

Table 1-3 SDO_ADMIN Package Subprograms

Subprogram	Description
POPULATE_INDEX	Creates a spatial index on a table containing spatial data.
UPDATE_INDEX	Updates the spatial index for a given spatial object instance.

SDO_GEOM

Table 1-4 SDO_GEOM Package Subprograms

Subprogram	Description
RELATE	Determines the topological relationship between two spatial objects.
VALIDATE_GEOMETRY	Evaluates geometric integrity constraints for a spatial object.
WITHIN_DISTANCE	Determines if two spatial objects are within a given Euclidean distance of each other.

SDO_MIGRATE

Table 1-5 SDO_MIGRATE Package Subprograms

Subprogram	Description
TO_81x	Migrates spatial data from a 7.3.3 or 7.3.4 database to an 8.1.x database.

SDO_TUNE

Table 1-6 SDO_TUNE Package Subprograms

Subprogram	Description
ESTIMATE_TILING_ LEVEL	Suggests a value for the parameter that determines the resolution of the spatial index.

TimeScale

Table 1-7 TimeScale Package Subprograms

Subprogram	Description
Scaledown Interpolate	Returns a time series in which data values are interpolated between values in the input time series.
ScaledownRepeat	Returns a time series in which data values in the input time series are repeated.
ScaledownSplit	Returns a time series in which data values reflect the division of the data value in the input time series by the number of associated timestamps in the resulting time series.
ScaleupAvg	Returns a time series reflecting the average value of each scaled group of values.
ScaleupAvgX	Returns a time series reflecting the average value of each scaled group of values plus the immediately preceding source period.
ScaleupCount	Returns a time series reflecting the count of non-null timestamps in each scaled group of values.
ScaleupFirst	Returns a time series reflecting the first non-null value of each scaled group of values.
ScaleupGMean	Returns a time series reflecting the geometric mean of each scaled group of values.
ScaleupLast	Returns a time series reflecting the last non-null value of each scaled group of values.
ScaleupMax	Returns a time series reflecting the maximum value of each scaled group of values.
ScaleupMin	Returns a time series reflecting the minimum value of each scaled group of values.
ScaleupSum	Returns a time series reflecting the sum of each scaled group of values.
ScaleupSumAnnual	Returns a time series reflecting the sum, expressed as an annual rate, of each scaled group of values.

TimeSeries

Table 1-8 TimeSeries Package Subprograms

Subprogram	Description
Cavg	Returns an `ORDTNumSeries` with each element containing the cumulative average up to and including the corresponding element in the input `ORDTNumSeries`.
Cmax	Returns an `ORDTNumSeries` with each element containing the cumulative maximum up to and including the corresponding element in the input `ORDTNumSeries`.
Cmin	Returns an `ORDTNumSeries` with each element containing the cumulative minimum up to and including the corresponding element in the input `ORDTNumSeries`.
Cprod	Returns an `ORDTNumSeries` with each element containing the cumulative product of multiplication up to and including the corresponding element in the input `ORDTNumSeries`.
Csum	Returns an `ORDTNumSeries` with each element containing the cumulative sum up to and including the corresponding element in the input `ORDTNumSeries`.
DeriveExceptions	Derives calendar exceptions from a time series, a calendar and a table of dates, or two time series.
Display	Displays various information using `DBMS_OUTPUT` routines.
DisplayValTS	Displays the results returned by the `ValidateTS` function.
ExtractCal	Returns a calendar that is the same as the calendar on which the time series is based.
ExtractDate	Returns the date.
ExtractTable	Returns the time series table (`ORDTNumTab` or `ORDTVarchar2Tab`) associated with the time series.
ExtractValue	Returns the value stored in a given element in a time series.
Fill	Returns a time series in which values for missing dates are inserted.
First	Returns the first element in a given time series.
FirstN	Returns the first `NumValues` elements in the given time series.
GetDatedElement	Returns the time series element for a given date.
GetNthElement	Returns the Nth element (element whose position corresponds to `target_index`) in the specified time series, or within the date range if one is specified.
GetSeries	Returns a time series instance (`ORDTNumSeries` or `ORDTVarchar2Series`).
IsValidTS	Returns 1 if the time series is valid and 0 if the time series is invalid.
Lag	Returns a time series that lags or (for negative numeric values) leads the input time series by the appropriate number of timestamps.
Last	Returns the last element in a given time series.
LastN	Returns the last `NumValues` elements in the time series.
Lead	Returns a time series that leads or (for negative numeric values) lags the input time series by the appropriate number of timestamps.
Mavg	Returns a moving average for the given time series, or for the date range if one is specified.
Msum	Returns a moving sum for the time series, or for the date range if one is specified.
TrimSeries	Returns an `ORDT` series of the same type with all data outside of the given date range removed.
TSAdd	Given two input time series or a time series and a constant, and optionally starting and ending dates, returns a time series that reflects the addition of the first two parameters.
TSAvg	Given an input `ORDTNumSeries` and optionally starting and ending dates, returns a number corresponding to the average of all non-null time series entries.
TSCount	Given an input `ORDTNumSeries` and optionally starting and ending dates, returns a number corresponding to the count of all non-null time series entries.
TSDivide	Given two input time series or a time series and a constant, and optionally starting and ending dates, returns a time series that reflects the division of the first parameter by the second parameter.
TSMax	Given an input `ORDTNumSeries` and optionally starting and ending dates, returns a number corresponding to the highest (maximum) of all non-null time series entries.
TSMaxN	Returns an `ORDTNumTab` with the specified number (`NumValues`) of the top (`highest`) values.
TSMedian	Returns a number corresponding to the median of all non-null time series entries.
TSMin	Returns a number corresponding to the lowest (minimum) of all non-null time series entries.
TSMinN	Returns an `ORDTNumTab` with the specified number (`NumValues`) of the bottom (lowest) values.
TSMultiply	Given two input time series or a time series and a constant, and optionally starting and ending dates, returns a time series that reflects the multiplication of the first parameter by the second parameter.
TSProd	Returns a number corresponding to the product (result of multiplication) of all non-null time series entries.
TSStdDev	Returns a number corresponding to the standard deviation of all non-null time series entries.
TSSubtract	Given two input time series or a time series and a constant, and optionally starting and ending dates, returns a time series that reflects the subtraction of the second parameter from the first parameter.
TSSum	Returns a number corresponding to the sum of all non-null time series entries.
TSVariance	Returns a number corresponding to the variance of all non-null time series entries.
ValidateTS	Checks whether a time series is valid, and if the time series is not valid, outputs a diagnostic message and tables with timestamps that are causing the time series to be invalid.

TSTools

Table 1-9 TSTools Package Subprograms

Subprogram	Description
Add_Existing_Column	Adds a column attribute from an existing flat table to a time series.
Add_Integer_Column	Adds an integer column attribute to an ongoing flat time series creation specification.
Add_Number_Column	Adds an integer column attribute to an ongoing flat time series creation specification.
Add_Varchar2_Column	Adds a `VARCHAR2` column attribute to an ongoing flat time series creation specification.
Begin_Create_TS_ Schema	Initiates the context for creating the schema objects for a time series.
Cancel_Create_TS_ Schema	Cancels the creation of a time series schema.
Close_Log	Closes the log file that had been opened by the `Open_Log` procedure.
Display_Attributes	Displays information about the time series schema being created.
Drop_TS_Schema	Deletes the time series schema definition and all views associated with it.
Drop_TS_Schema_All	Deletes the time series schema definition and all tables, views, indexes, constraints, and triggers associated with it.
End_Create_TS_ Schema	Closes the context established by the `Begin_Create_TS_Schema` procedure and creates all appropriate schema objects.
Get_Flat_Attributes	Retrieves the attributes of a flat time series.
Get_Object_ Attributes	Retrieves the attributes of an object-model time series.
Get_Status	Checks whether s time series creation sequence is in progress.
Open_Log	Opens a log file that will contain the data definition language (DDL) statements generated by the Time Series administrative tools procedures.
Set_Flat_Attributes	Sets the attributes of a flat time series.
Set_Object_ Attributes	Sets the attributes of an object-model time series.
Trace_Off	Disables debugging for Time Series cartridge administrative tools procedures.
Trace_On	Enables debugging for Time Series cartridge administrative tools procedures.

UTL_PG

Table 1-10 UTL_PG Package Subprograms

Subprogram	Description
MAKE_NUMBER_TO_RAW_ FORMAT	Makes a `number_to_raw` format conversion specification used to convert an Oracle number of declared precision and scale to a `RAW` byte-string in the remote host internal format.
MAKE_RAW_TO_NUMBER_ FORMAT	Makes a `raw_to_number` format conversion specification used to convert a `RAW` byte-string from the remote host internal format into an Oracle number of comparable precision and scale.
NUMBER_TO_RAW	Converts an Oracle number of declared precision and scale to a `RAW` byte-string in the remote host internal format.
NUMBER_TO_RAW_ FORMAT	Converts, according to the `number_to_raw` conversion format n2rfmt, an Oracle number numval of declared precision and scale to a `RAW` byte-string in the remote host internal format.
RAW_TO_NUMBER	Converts a `RAW` byte-string from the remote host internal format into an Oracle number.
RAW_TO_NUMBER_ FORMAT	Converts, according to the `raw_to_number` conversion format `r2nfmt`, a `RAW` byte-string `rawval` in the remote host internal format to an Oracle number.
WMSG	Extracts a warning message specified by `wmsgitem` from `wmsgblk`.
WMSGCNT	Tests a `wmsgblk` to determine how many warnings, if any, are present.

Vir_Pkg

Table 1-11 Vir_Pkg Package Subprograms

Subprogram	Description
Analyze	Analyzes an image `BLOB` or `BFILE`, derives information relating to the visual attributes, and creates the image signature.
Convert	Converts the image signature to a format usable by the host machine, or converts the signature from the format used for Viisage face-recognition to a signature usable by the `Score` and `Similar` operators.
Score	Compares the signature of two images and returns a number representing the weighted sum of the distances for the visual attributes.
Similar	Determines whether or not two images match.