Oracle CTX_ENTITY
Version 21c

General Information
Library Note Morgan's Library Page Header
ACE Director Alum Daniel Morgan, founder of Morgan's Library, is scheduling complimentary technical Workshops on Database Security for the first 30 Oracle Database customers located anywhere in North America, EMEA, LATAM, or APAC that send an email to asra_us@oracle.com. Request a Workshop for your organization today.
Purpose Context Administration DR ENTity with functions for entity extraction
AUTHID CURRENT_USER
Constants
Name Data Type Value
 Lock Consants
LOCK_WAIT NUMBER 0
LOCK_NOWAIT NUMBER 1
LOCK_NOWAIT_ERROR NUMBER 2
 Compile Constants
COMPILE_ALL NUMBER 0
COMPILE_RULES NUMBER 1
COMPILE_STOP_ENTITIES NUMBER 2
 Status Constants
STATUS_NOTCOMPILED NUMBER 0
STATUS_TOBEDELETED NUMBER 1
STATUS_COMPILED NUMBER 2
STATUS_SUBSET NUMBER 3
Dependencies
DBMS_STANDARD DRIPREF DRV$USER_EXTRACT_TYPE
DRIACC DRIUTL DRVDISP
DRIENT DRIXMD DRVDOC
DRIENTL DRUE DRVIMR
DRIG DRV$USER_EXTRACT_ENTDICT DRVUTL
DRILIST DRV$USER_EXTRACT_RULE DRVXMD
DRIOBJ DRV$USER_EXTRACT_STOP_ENTITY DR_DEF
DRIPARSE DRV$USER_EXTRACT_TKDICT ODCIINDEXINFO
Documented Yes: Packages and Types Reference
First Available Not known
Security Model Owned by CTXSYS with EXECUTE granted to the CTXAPP role in $ORACLE_HOME/ctx/admin/ctxplb.sql
Source {ORACLE_HOME}/ctx/admin/dr0ent.pkh
Subprograms
 
ADD_EXTRACT_RULE
Add a user-defined extraction rule to a policy object ctx_entity.add_extract_rule(
policy_name     IN VARCHAR2,
rule_id         IN INTEGER,
extraction_rule IN VARCHAR2);
PRAGMA SUPPLEMENTAL_LOG_DATA(add_extract_rule, AUTO);
TBD
 
ADD_STOP_ENTITY
Adds an entity that is not to be classified - a "stop entity" - to the policy ctx_entity.add_stop_entity(
policy_name IN VARCHAR2,
entity_name IN VARCHAR2 DEFAULT NULL,
entity_type IN VARCHAR2 DEFAULT NULL,
comments    IN VARCHAR2 DEFAULT NULL);
PRAGMA SUPPLEMENTAL_LOG_DATA(add_stop_entity, AUTO);
TBD
 
COMPILE
Compiles added extraction rules and stop-entities into an extract policy ctx_entity.compile(
policy_name    IN VARCHAR2,
compile_choice IN NUMBER DEFAULT COMPILE_ALL,
locking        IN NUMBER DEFAULT LOCK_NOWAIT_ERROR);
PRAGMA SUPPLEMENTAL_LOG_DATA(compile, AUTO)
TBD
 
CREATE_EXTRACT_POLICY
Create an entity-extraction policy ctx_entity.create_extract_policy(
policy_name                 IN VARCHAR2,
lexer                       IN VARCHAR2 DEFAULT NULL,
include_supplied_rules      IN BOOLEAN  DEFAULT TRUE,
include_supplied_dictionary IN BOOLEAN  DEFAULT TRUE);
PRAGMA SUPPLEMENTAL_LOG_DATA(create_extract_policy, AUTO);
TBD
 
DROP_EXTRACT_POLICY
Drop an entity-extraction policy ctx_entity.drop_extract_policy(policy_name IN VARCHAR2);
PRAGMA SUPPLEMENTAL_LOG_DATA(drop_extract_policy, AUTO);
TBD
 
EXTRACT
Generates character offsets and character lengths of an extracted entity from base document ctx_entity.extract(
policy_name      IN            VARCHAR2,
document         IN            CLOB,
language         IN            VARCHAR2,
result           IN OUT NOCOPY CLOB,
entity_type_list IN            CLOB   DEFAULT NULL,
locking          IN            NUMBER DEFAULT LOCK_NOWAIT_ERROR);
TBD
 
IMPORT_DICTIONARY
Undocumented ctx_entity.import_dictionary(
policy_name IN VARCHAR2,
data        IN CLOB,
isdrop      IN BOOLEAN DEFAULT FALSE);
PRAGMA SUPPLEMENTAL_LOG_DATA(import_dictionary, AUTO);
TBD
 
REMOVE_EXTRACT_RULE
remove an extraction rule from an extract policy ctx_entity.remove_extract_rule(
policy_name IN VARCHAR2,
rule_id     IN INTEGER);
PRAGMA SUPPLEMENTAL_LOG_DATA(remove_extract_rule, AUTO);
TBD
 
REMOVE_STOP_ENTITY
Removes a stop entity from an extract policy ctx_entity.remove_stop_entity(
policy_name IN VARCHAR2,
entity_name IN VARCHAR2 DEFAULT NULL,
entity_type IN VARCHAR2 DEFAULT NULL);
PRAGMA SUPPLEMENTAL_LOG_DATA(remove_stop_entity, AUTO);
TBD

Related Topics
Built-in Functions
Built-in Packages
Database Security
CTX_ADM
CTX_ANL
CTX_CATSEARCH
CTX_CLS
CTX_CONTAINS
CTX_DDL
CTX_DOC
CTX_MATCHES
CTX_OUTPUT
CTX_QUERY
CTX_REPORT
CTX_THES
CTX_TREE
CTX_ULEXER
CTX_XPCONTAINS
What's New In 21c
What's New In 23c

Morgan's Library Page Footer
This site is maintained by Dan Morgan. Last Updated: This site is protected by copyright and trademark laws under U.S. and International law. © 1998-2023 Daniel A. Morgan All Rights Reserved
  DBSecWorx