Package com.oracle.database.selectai

Interface DatabaseAdmin

All Superinterfaces:

AutoCloseable

public interface DatabaseAdmin
extends AutoCloseable

Administrative API contract for privileged database setup operations used by Select AI.

Normal application code should use SelectAI. Use DatabaseAdmin only from setup or administrative workflows that run with database users authorized to change package privileges, data-access settings, or network ACL entries.

Method Summary

Modifier and Type	Method	Description
void	close()	Releases resources owned by this DatabaseAdmin client.
static DatabaseAdmin	create(DbConnectionConfig dbConnectionConfig)	Creates a DatabaseAdmin client from database connection configuration.
static DatabaseAdmin	create(DbConnectionConfig dbConnectionConfig, SelectAIOptions options)	Creates a DatabaseAdmin client from database connection configuration and SDK execution options.
static DatabaseAdmin	create(DataSource dataSource)	Creates a DataSource-backed DatabaseAdmin client.
static DatabaseAdmin	create(DataSource dataSource, SelectAIOptions options)	Creates a DataSource-backed DatabaseAdmin client with SDK execution options.
boolean	disableDataAccess()	Prevents Select AI features from sending table data or vector-search document content to the model when those features would otherwise use it.
boolean	enableDataAccess()	Allows Select AI features to send table data or vector-search document content to the model when a feature needs that data.
boolean	grantHttpAccess(List<String> selectAIUsers, String host)	Grants HTTP network ACL access for the specified database users.
boolean	grantNetworkAccess(List<String> selectAIUsers, String host, List<String> privileges, Integer lowerPort, Integer upperPort)	Grants network ACL privileges to the specified database users.
boolean	grantPrivileges(List<String> selectAIUsers)	Grants required Select AI package privileges to the specified database users.
boolean	revokeHttpAccess(List<String> selectAIUsers, String host)	Revokes HTTP network ACL access for the specified database users.
boolean	revokeNetworkAccess(List<String> selectAIUsers, String host, List<String> privileges, Integer lowerPort, Integer upperPort)	Revokes network ACL privileges for the specified database users.
boolean	revokePrivileges(List<String> selectAIUsers)	Revokes required Select AI package privileges from the specified database users.

Method Details

create

static DatabaseAdmin create(DbConnectionConfig dbConnectionConfig)
                     throws SelectAIException

Creates a DatabaseAdmin client from database connection configuration.

For a complete runnable sample source, see GrantPrivilegesSample source.

Parameters:

dbConnectionConfig - database connection configuration

Returns:

DatabaseAdmin client

Throws:

IllegalArgumentException - when dbConnectionConfig is null

SelectAIException - when the database connection cannot be initialized

create

static DatabaseAdmin create(DbConnectionConfig dbConnectionConfig,
 SelectAIOptions options)
                     throws SelectAIException

Creates a DatabaseAdmin client from database connection configuration and SDK execution options.

For a complete runnable sample source, see CreateDatabaseAdminWithOptionsSample source.

Parameters:

dbConnectionConfig - database connection configuration

options - SDK execution options; null uses SelectAIOptions.defaults()

Returns:

DatabaseAdmin client

Throws:

IllegalArgumentException - when dbConnectionConfig is null

SelectAIException - when the database connection cannot be initialized

create

static DatabaseAdmin create(DataSource dataSource)

Creates a DataSource-backed DatabaseAdmin client.

For a complete runnable sample source, see CreateDatabaseAdminDataSourceSample source.

Parameters:

dataSource - DataSource used to obtain JDBC connections

Returns:

DatabaseAdmin client

Throws:

IllegalArgumentException - when dataSource is null

create

static DatabaseAdmin create(DataSource dataSource,
 SelectAIOptions options)

Creates a DataSource-backed DatabaseAdmin client with SDK execution options.

For a complete runnable sample source, see CreateDatabaseAdminDataSourceWithOptionsSample source.

Parameters:

dataSource - DataSource used to obtain JDBC connections

options - SDK execution options; null uses SelectAIOptions.defaults()

Returns:

DatabaseAdmin client

Throws:

IllegalArgumentException - when dataSource is null

enableDataAccess

boolean enableDataAccess()
                  throws SelectAIException

Allows Select AI features to send table data or vector-search document content to the model when a feature needs that data.

For a complete runnable sample source, see EnableSelectAIDataAccessSample source.

Returns:

true when the database accepts the enable request

Throws:

SelectAIException - when the database rejects or cannot execute the enable request

disableDataAccess

boolean disableDataAccess()
                   throws SelectAIException

Prevents Select AI features from sending table data or vector-search document content to the model when those features would otherwise use it.

For a complete runnable sample source, see DisableSelectAIDataAccessSample source.

Returns:

true when the database accepts the disable request

Throws:

SelectAIException - when the database rejects or cannot execute the disable request

grantPrivileges

boolean grantPrivileges(List<String> selectAIUsers)
                 throws SelectAIException

Grants required Select AI package privileges to the specified database users.

For a complete runnable sample source, see GrantPrivilegesSample source.

Parameters:

selectAIUsers - database users whose package privileges are granted

Returns:

false when the user list is null or empty; otherwise true when the grant requests complete

Throws:

SelectAIException - when package grants cannot be applied

revokePrivileges

boolean revokePrivileges(List<String> selectAIUsers)
                  throws SelectAIException

Revokes required Select AI package privileges from the specified database users.

For a complete runnable sample source, see RevokePrivilegesSample source.

Parameters:

selectAIUsers - database users whose package privileges are revoked

Returns:

false when the user list is null or empty; otherwise true when the revoke requests complete

Throws:

SelectAIException - when package grants cannot be revoked

grantHttpAccess

boolean grantHttpAccess(List<String> selectAIUsers,
 String host)
                 throws SelectAIException

Grants HTTP network ACL access for the specified database users.

For a complete runnable sample source, see GrantHttpAccessSample source.

Parameters:

selectAIUsers - database users whose HTTP access is granted

host - host name or host pattern to add to the ACL

Returns:

false when the user list is null or empty; otherwise true when the grant requests complete

Throws:

IllegalArgumentException - when host is null or blank

SelectAIException - when network ACL updates cannot be applied

revokeHttpAccess

boolean revokeHttpAccess(List<String> selectAIUsers,
 String host)
                  throws SelectAIException

Revokes HTTP network ACL access for the specified database users.

For a complete runnable sample source, see RevokeHttpAccessSample source.

Parameters:

selectAIUsers - database users whose HTTP access is revoked

host - host name or host pattern to remove from the ACL

Returns:

false when the user list is null or empty; otherwise true when the revoke requests complete

Throws:

IllegalArgumentException - when host is null or blank

SelectAIException - when network ACL updates cannot be revoked

grantNetworkAccess

boolean grantNetworkAccess(List<String> selectAIUsers,
 String host,
 List<String> privileges,
 Integer lowerPort,
 Integer upperPort)
                    throws SelectAIException

Grants network ACL privileges to the specified database users.

For a complete runnable sample source, see GrantNetworkAccessSample source.

Parameters:

selectAIUsers - database users whose network access is granted

host - host name or host pattern to add to the ACL

privileges - network ACL privileges to grant, such as http or connect

lowerPort - optional lower port; pass null when not needed

upperPort - optional upper port; pass null when not needed

Returns:

false when the user list is null or empty; otherwise true when the grant requests complete

Throws:

IllegalArgumentException - when host is null or blank, privileges has no non-blank values, a port is outside 0..65535, or lowerPort is greater than upperPort

SelectAIException - when network ACL updates cannot be applied

revokeNetworkAccess

boolean revokeNetworkAccess(List<String> selectAIUsers,
 String host,
 List<String> privileges,
 Integer lowerPort,
 Integer upperPort)
                     throws SelectAIException

Revokes network ACL privileges for the specified database users.

For a complete runnable sample source, see RevokeNetworkAccessSample source.

Parameters:

selectAIUsers - database users whose network access is revoked

host - host name or host pattern to remove from the ACL

privileges - network ACL privileges to revoke, such as http or connect

lowerPort - optional lower port; pass null when not needed

upperPort - optional upper port; pass null when not needed

Returns:

false when the user list is null or empty; otherwise true when the revoke requests complete

Throws:

IllegalArgumentException - when host is null or blank, privileges has no non-blank values, a port is outside 0..65535, or lowerPort is greater than upperPort

SelectAIException - when network ACL updates cannot be revoked

close

void close()
    throws SelectAIException

Releases resources owned by this DatabaseAdmin client.

For a complete runnable sample source, see CloseDatabaseAdminSample source.

Specified by:

close in interface AutoCloseable

Throws:

SelectAIException - when an owned JDBC connection cannot be closed