Monkeybread Xojo plugin - JavaDatabaseMetaDataMBS methods

Platforms to show: All Mac Windows Linux Cross-Platform

JavaDatabaseMetaDataMBS.getMaxIndexLength as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of bytes this database allows for an index, including all of the parts of the index.

Returns the maximum number of bytes allowed; this limit includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getMaxProcedureNameLength as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of characters that this database allows in a procedure name.

Returns the maximum number of characters allowed in a procedure name; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getMaxRowSize as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of bytes this database allows in a single row.

Returns the maximum number of bytes allowed for a row; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getMaxSchemaNameLength as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of characters that this database allows in a schema name.

Returns the maximum number of characters allowed in a schema name; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getMaxStatementLength as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of characters this database allows in an SQL statement.

Returns the maximum number of characters allowed for an SQL statement; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getMaxStatements as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of active statements to this database that can be open at the same time.

Returns the maximum number of statements that can be open at one time; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getMaxTableNameLength as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of characters this database allows in a table name.

Returns the maximum number of characters allowed for a table name; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getMaxTablesInSelect as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of tables this database allows in a SELECT statement.

Returns the maximum number of tables allowed in a SELECT statement; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getMaxUserNameLength as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the maximum number of characters this database allows in a user name.

Returns the maximum number of characters allowed for a user name; a result of zero means that there is no limit or the limit is not known

JavaDatabaseMetaDataMBS.getNumericFunctions as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a comma-separated list of math functions available with this database.

These are the Open /Open CLI math function names used in the JDBC function escape clause.

JavaDatabaseMetaDataMBS.getPrimaryKeys(catalog as string, schema as string, table as string) as JavaResultSetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	9.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a description of the given table's primary key columns. They are ordered by COLUMN_NAME.

Each primary key column description has the following columns:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
COLUMN_NAME String => column name
KEY_SEQ short => sequence number within primary key
PK_NAME String => primary key name (may be null)
Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schema - a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
table - a table name; must match the table name as it is stored in the database

Returns:
ResultSet - each row is a primary key column description

JavaDatabaseMetaDataMBS.getProcedureColumns(catalog as string, schemaPattern as string, procedureNamePattern as string, columnNamePattern as string) as JavaResultSetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	9.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a description of the given catalog's stored procedure parameter and result columns.

Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.

Each row in the ResultSet is a parameter description or column description with the following fields:

PROCEDURE_CAT String => procedure catalog (may be null)
PROCEDURE_SCHEM String => procedure schema (may be null)
PROCEDURE_NAME String => procedure name
COLUMN_NAME String => column/parameter name
COLUMN_TYPE Short => kind of column/parameter:
procedureColumnUnknown - nobody knows
procedureColumnIn - IN parameter
procedureColumnInOut - INOUT parameter
procedureColumnOut - OUT parameter
procedureColumnReturn - procedure return value
procedureColumnResult - result column in ResultSet
DATA_TYPE int => SQL type from java.sql.Types
TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
PRECISION int => precision
LENGTH int => length in bytes of data
SCALE short => scale
RADIX short => radix
NULLABLE short => can it contain NULL.
procedureNoNulls - does not allow NULL values
procedureNullable - allows NULL values
procedureNullableUnknown - nullability unknown
REMARKS String => comment describing parameter/column
Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
procedureNamePattern - a procedure name pattern; must match the procedure name as it is stored in the database
columnNamePattern - a column name pattern; must match the column name as it is stored in the database
Returns:
ResultSet - each row describes a stored procedure parameter or column
Throws:
SQLException - if a database access error occurs

JavaDatabaseMetaDataMBS.getProcedures(catalog as string, schemaPattern as string, procedureNamePattern as string) as JavaResultSetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	9.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a description of the stored procedures available in the given catalog.

Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME.

Each procedure description has the the following columns:

PROCEDURE_CAT String => procedure catalog (may be null)
PROCEDURE_SCHEM String => procedure schema (may be null)
PROCEDURE_NAME String => procedure name
reserved for future use
reserved for future use
reserved for future use
REMARKS String => explanatory comment on the procedure
PROCEDURE_TYPE short => kind of procedure:
procedureResultUnknown - May return a result
procedureNoResult - Does not return a result
procedureReturnsResult - Returns a result
Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
procedureNamePattern - a procedure name pattern; must match the procedure name as it is stored in the database

Returns:
ResultSet - each row is a procedure description

Throws:
SQLException - if a database access error occurs

JavaDatabaseMetaDataMBS.getProcedureTerm as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the database vendor's preferred term for "procedure".

JavaDatabaseMetaDataMBS.getResultSetHoldability as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the default holdability of this ResultSet object.

Returns:
the default holdability; either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

JavaDatabaseMetaDataMBS.getSchemas as JavaResultSetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	9.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the schema names available in this database.

The results are ordered by schema name.

The schema column is:

TABLE_SCHEM String => schema name
TABLE_CATALOG String => catalog name (may be null)
Returns:
a ResultSet object in which each row is a schema decription

Throws:
SQLException - if a database access error occurs

JavaDatabaseMetaDataMBS.getSchemaTerm as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the database vendor's preferred term for "schema".

JavaDatabaseMetaDataMBS.getSearchStringEscape as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves the string that can be used to escape wildcard characters.

This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters).
The '_' character represents any single character; the '%' character represents any sequence of zero or more characters.

JavaDatabaseMetaDataMBS.getSQLKeywords as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL92 keywords.

JavaDatabaseMetaDataMBS.getSQLStateType as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Indicates whether the SQLSTATE returned by SQLException.getSQLState is X/Open (now known as Open Group) SQL CLI or SQL99.

Returns:
the type of SQLSTATE; one of: sqlStateXOpen or sqlStateSQL99

JavaDatabaseMetaDataMBS.getStringFunctions as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a comma-separated list of string functions available with this database.

These are the Open Group CLI string function names used in the JDBC function escape clause.

JavaDatabaseMetaDataMBS.getSuperTables(catalog as string, schemaPattern as string, tableNamePattern as string) as JavaResultSetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	9.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a description of the table hierarchies defined in a particular schema in this database.

Only supertable information for tables matching the catalog, schema and table name are returned. The table name parameter may be a fully- qualified name, in which case, the catalog and schemaPattern parameters are ignored. If a table does not have a super table, it is not listed here. Supertables have to be defined in the same catalog and schema as the sub tables. Therefore, the type description does not need to include this information for the supertable.

Each type description has the following columns:

TABLE_CAT String => the type's catalog (may be null)
TABLE_SCHEM String => type's schema (may be null)
TABLE_NAME String => type name
SUPERTABLE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.

Parameters:
catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern - a schema name pattern; "" retrieves those without a schema
tableNamePattern - a table name pattern; may be a fully-qualified name

Returns:
a ResultSet object in which each row is a type description

Throws:
SQLException - if a database access error occurs

JavaDatabaseMetaDataMBS.getSuperTypes(catalog as string, schemaPattern as string, typeNamePattern as string) as JavaResultSetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	9.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.

Only the immediate super type/ sub type relationship is modeled.
Only supertype information for UDTs matching the catalog, schema, and type name is returned. The type name parameter may be a fully-qualified name. When the UDT name supplied is a fully-qualified name, the catalog and schemaPattern parameters are ignored.

If a UDT does not have a direct super type, it is not listed here. A row of the ResultSet object returned by this method describes the designated UDT and a direct supertype. A row has the following columns:

TYPE_CAT String => the UDT's catalog (may be null)
TYPE_SCHEM String => UDT's schema (may be null)
TYPE_NAME String => type name of the UDT
SUPERTYPE_CAT String => the direct super type's catalog (may be null)
SUPERTYPE_SCHEM String => the direct super type's schema (may be null)
SUPERTYPE_NAME String => the direct super type's name
Note: If the driver does not support type hierarchies, an empty result set is returned.

Parameters:
catalog - a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern - a schema name pattern; "" retrieves those without a schema
typeNamePattern - a UDT name pattern; may be a fully-qualified name

Returns:
a ResultSet object in which a row gives information about the designated UDT

Throws:
SQLException - if a database access error occurs

JavaDatabaseMetaDataMBS.getSystemFunctions as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	8.5	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a comma-separated list of system functions available with this database.

These are the Open Group CLI system function names used in the JDBC function escape clause.

JavaDatabaseMetaDataMBS.getTablePrivileges(catalog as string, schemaPattern as string, tableNamePattern as string) as JavaResultSetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	9.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a description of the access rights for each table available in a catalog.

Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this privilege applies to all columns (this may be true for some systems but is not true for all.)
Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.

Each privilige description has the following columns:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
GRANTOR => grantor of access (may be null)
GRANTEE String => grantee of access
PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
IS_GRANTABLE String => "true" if grantee is permitted to grant to others; "false" if not; null if unknown
Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
tableNamePattern - a table name pattern; must match the table name as it is stored in the database

Returns:
ResultSet - each row is a table privilege description

Throws:
SQLException - if a database access error occurs

JavaDatabaseMetaDataMBS.getTables(catalog as string, schemaPattern as string, tableNamePattern as string) as JavaResultSetMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Java Database	MBS Java Plugin	9.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Retrieves a description of the tables available in the given catalog.

Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.
Each table description has the following columns:

TABLE_CAT String => table catalog (may be null)
TABLE_SCHEM String => table schema (may be null)
TABLE_NAME String => table name
TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
REMARKS String => explanatory comment on the table
TYPE_CAT String => the types catalog (may be null)
TYPE_SCHEM String => the types schema (may be null)
TYPE_NAME String => type name (may be null)
SELF_REFERENCING_COL_NAME String => name of the designated "identifier" column of a typed table (may be null)
REF_GENERATION String => specifies how values in SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED". (may be null)
Note: Some databases may not return information for all tables.

Parameters:
catalog - a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; null means that the catalog name should not be used to narrow the search
schemaPattern - a schema name pattern; must match the schema name as it is stored in the database; "" retrieves those without a schema; null means that the schema name should not be used to narrow the search
tableNamePattern - a table name pattern; must match the table name as it is stored in the database
types - a list of table types to include (optionally)

Returns:
ResultSet - each row is a table description

Throws:
SQLException - if a database access error occurs