BROWSE_TABLE

<< Click to Display Table of Contents >>

Navigation:  Streaming SQL Reference Guide > Basic Building Blocks > Functions > Built-in Functions > General Management Functions >

BROWSE_TABLE

Previous pageReturn to chapter overviewNext page

Returns the set of options relevant to a table created within a given foreign data server.  The foreign data server must have already been created. You can pass in a partial set of options via the proposed_table_options cursor parameter, which must have two columns (OPTION_NAME and OPTION_VALUE, in that order).  This allows for an incremental interaction, starting with specifying no options, then some, then more, stopping once user and wrapper are both satisfied.

The locale_name parameter can either be the name of the locale for which to return descriptions (such as 'en_US'), or NULL to use the server's default locale. The result set is not fully normalized, because some options support a list of choices (such as for a dropdown selection UI widget). optional_choice_ordinal -1 represents the "current" choice (either proposed by the user or chosen as default by the wrapper). Other choice ordinals starting from 0 represent possible choices (if known).

5_2_indicator

Version 5.2 Feature

As of version 5.2, you no longer need to use the preface SYS_BOOT.MGMT.

Syntax:

select * from table(SYS_BOOT.MGMT.BROWSE_TABLE(

FOREIGN_SERVER_NAME,

PROPOSED_TABLE_OPTIONS,

LOCALE_NAME))

);

 

Returns table:

Field

Type

option_ordinal

integer

option_name

varchar(128)

option_description

varchar(4096)

is_option_required

boolean

option_choice_ordinal

int

option_choice_value

varchar(4096)