Oracle8 Distributed Database Systems Release 8.0 A58247-01 |
Library | Product | Contents | Index

# B
DBMS_HS Package Reference

This appendix provides all the interface information for the DBMS_HS package for administering the Heterogeneous Services. See Chapter 7, "Administering Oracle Heterogeneous Services" for more information about administering the Heterogeneous Services.

Referenced in this appendix are:

- DBMS_HS.CREATE_FDS_INST
- DBMS_HS.CREATE_INST_INIT
- DBMS_HS.DROP_FDS_INST
- DBMS_HS.DROP_INST_INIT

## DBMS_HS.CREATE_FDS_INST

### Purpose

To register an instance of the non-Oracle system in the Oracle8 server. This is the logical name of the non-Oracle system instance, as know by Heterogeneous Services. Information about registered instances is available through the view HS_FDS_INST.

### Interface description

    PROCEDURE create_fds_inst(
    FDS_INST_NAME     IN VARCHAR2,
    FDS_CLASS_NAME    IN VARCHAR2,
    FDS_INST_COMMENTS IN VARCHAR2 )

#### Parameters and Descriptions

#####

Parameter | Description
--- | ---
FDS_INST_NAME | Non-Oracle system instance to be registered in the Oracle8 server
FDS_CLASS_NAME | The class associated with the non-Oracle system instance.
FDS_INST_COMMENTS | Provides up to 255 bytes to describe the instance of the non-Oracle system.

#### Exceptions

#####

Exception | Description
--- | ---
ORA-24270 | The instance already exists
ORA-24274 | The object could not be created. Did you pass an existing CLASS or INSTANCE name?

### See Also

DBMS_HS.DROP_FDS_INST

## DBMS_HS.CREATE_INST_INIT

### Purpose

To create an initialization variable for an instance of the non-Oracle system. See Chapter 7, "Administering Oracle Heterogeneous Services" for more information on how to create initialization variables. See Appendix A, "Heterogeneous Services Initialization Parameters" for possible initialization parameters that can be set. The information will be available through the view HS_INST_INIT.

### Interface description

    PROCEDURE create_inst_init(
    FDS_INST_NAME    IN VARCHAR2
    FDS_CLASS_NAME   IN VARCHAR2
    INIT_VALUE_NAME  IN VARCHAR2,
    INIT_VALUE       IN VARCHAR2,
    INIT_VALUE_TYPE  IN VARCHAR2);

#### Parameters and Descriptions

#####

Parameter | Description
--- | ---
FDS_INST_NAME | Non-Oracle system instance for which the initialization parameter needs to be applied.
FDS_CLASS_NAME | The class associated with the non-Oracle system instance.
INIT_VALUE_NAME | Name of the initialization parameters. See Appendix A, "Heterogeneous Services Initialization Parameters" for possible values.
INIT_VALUE | Value of the initialization parameter
INIT_VALUE_TYPE | Must be 'T' if initialization parameter must be set as an environment variable of the agent process 'F' for a regular initialization parameter (default)

#### Exceptions

#####

Exception | Description
--- | ---
ORA-24270 | The initialization parameter is already defined for this instance
ORA-24272 | The INIT_VALUE_TYPE is not 'T' or 'F'.
ORA-24274 | The initialization parameter could not be created. Did you pass an existing CLASS or INSTANCE name?

### See Also

DBMS_HS.DROP_INST_INIT

## DBMS_HS.DROP_FDS_INST

### Purpose

To unregister a non-Oracle system instance. The view HS_FDS_INST contains information about registered instances.

### Interface Description

    PROCEDURE drop_fds_inst(
    FDS_INST_NAME  IN VARCHAR2,
    FDS_CLASS_NAME IN VARCHAR2)

#### Parameters and Descriptions

#####

Parameter | Description
--- | ---
FDS_INST_NAME | Non-Oracle system instance to be unregistered in the Oracle8 server.
FDS_CLASS_NAME | The class associated with the non-Oracle system instance.

#### Exceptions

#####

Exception | Description
--- | ---
ORA-24274 | The instance could not be dropped. Did you pass an existing CLASS or INSTANCE name?

### See Also

DBMS_HS.CREATE_FDS_INST

## DBMS_HS.DROP_INST_INIT

### Purpose

To drop an initialization variable of a specific non-Oracle system instance. You can query initialization parameters that are defined for a particular instance using the HS_INST_INIT and HS_ALL_INIT view.

### Interface description

    PROCEDURE drop_inst_init(
    FDS_INST_NAME   IN VARCHAR2,
    FDS_CLASS_NAME  IN VARCHAR2,
    INIT_VALUE_NAME IN VARCHAR2)

#### Parameters and Descriptions

#####

Parameter | Description
--- | ---
FDS_INST_NAME | Non-Oracle system instance for which the initialization parameter needs to be dropped.
FDS_CLASS_NAME | The class associated with the non-Oracle system instance.
INIT_VALUE_NAME | Name of the initialization parameters.

#### Exceptions

#####

Exception | Description
--- | ---
ORA-24274 | The initialization parameter could not be dropped. Did you pass an existing CLASS or INSTANCE name?

### See Also

DBMS_HS.CREATE_INST_INIT

###

Prev | Next
| Copyright © 1997 Oracle Corporation. All Rights Reserved. |
Library | Product | Contents | Index