DBA Data[Home] [Help]

PACKAGE: XDB.DBMS_SODA_ADMIN

Source


1 package     DBMS_SODA_ADMIN authid current_user as
2 
3   --
4   -- Error messages which we can ignore
5   --
6   SQL_OBJECT_EXISTS         constant number := -955;
7   SQL_OBJECT_NOT_EXISTS     constant number := -942;
8 
9   --
10   type VCTAB is table of varchar2(32767) index by binary_integer;
11   --
12   -- List collections by returning a cursor which delivers two
13   -- columns: the URI name and a JSON descriptor. The results
14   -- are returning in URI string order.
15   -- An optional argument can be used to specify a starting URI string
16   -- (possibly useful for paginated reading of large schemas).
17   --
18   procedure LIST_COLLECTIONS(P_START_NAME in  varchar2 default null,
19                              P_RESULTS    out SYS_REFCURSOR);
20   --
21   -- Describe a single collection. The input collection name is
22   -- case-sensitive. If a match is found, the case-sensitive actual
23   -- URI name is returned along with the descriptor body.
24   --
25   procedure DESCRIBE_COLLECTION(P_URI_NAME   in out nvarchar2,
26                                 P_DESCRIPTOR    out varchar2);
27   --
28   -- Create a collection for a specified URI name, with a specified
29   -- descriptor. The URI name is case-sensitive.
30   -- Note that the descriptor stored in the table may differ from
31   -- from the input descriptor if values are defaulted during validation.
32   --
33   procedure CREATE_COLLECTION(P_URI_NAME    in     nvarchar2,
34                               P_CREATE_MODE in     varchar2 default 'MAP',
35                               P_DESCRIPTOR  in out varchar2,
36                               P_CREATE_TIME out    varchar2);
37   --
38   -- Drop a collection given the name. This forcibly drops the
39   -- the collection regardless of the drop policy, which must
40   -- be enforced by the calling code layer.
41   --
42   procedure DROP_COLLECTION(P_URI_NAME in nvarchar2);
43   --
44   -- Returns RDBMS parameters as name/value pairs.
45   -- Currently returns 3 values:
46   --       PKEY             P_VALUE
47   --   (1) "VARCHAR2_MAX"   4000 or 32767
48   --   (2) "RAW_MAX"        2000 or 32767
49   --   (3) "NVARCHAR2_MAX"  2000, 4000, 16383, or 32767
50   --
51   procedure GET_PARAMETERS (P_KEY   in out VCTAB,
52                             P_VALUE in out VCTAB);
53   --
54 end DBMS_SODA_ADMIN;