123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271 |
- /* DatabaseMetaData.java -- Information about the database itself.
- Copyright (C) 1999, 2000, 2001, 2002, 2006 Free Software Foundation, Inc.
- This file is part of GNU Classpath.
- GNU Classpath is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2, or (at your option)
- any later version.
- GNU Classpath is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with GNU Classpath; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- 02110-1301 USA.
- Linking this library statically or dynamically with other modules is
- making a combined work based on this library. Thus, the terms and
- conditions of the GNU General Public License cover the whole
- combination.
- As a special exception, the copyright holders of this library give you
- permission to link this library with independent modules to produce an
- executable, regardless of the license terms of these independent
- modules, and to copy and distribute the resulting executable under
- terms of your choice, provided that you also meet, for each linked
- independent module, the terms and conditions of the license of that
- module. An independent module is a module which is not derived from
- or based on this library. If you modify this library, you may extend
- this exception to your version of the library, but you are not
- obligated to do so. If you do not wish to do so, delete this
- exception statement from your version. */
- package java.sql;
- public interface DatabaseMetaData
- {
- /**
- * It is unknown whether or not the procedure returns a result.
- */
- int procedureResultUnknown = 0;
- /**
- * The procedure does not return a result.
- */
- int procedureNoResult = 1;
- /**
- * The procedure returns a result.
- */
- int procedureReturnsResult = 2;
- /**
- * The column type is unknown.
- */
- int procedureColumnUnknown = 0;
- /**
- * The column type is input.
- */
- int procedureColumnIn = 1;
- /**
- * The column type is input/output.
- */
- int procedureColumnInOut = 2;
- /**
- * The column type is output
- */
- int procedureColumnOut = 4;
- /**
- * The column is used for return values.
- */
- int procedureColumnReturn = 5;
- /**
- * The column is used for storing results
- */
- int procedureColumnResult = 3;
- /**
- * NULL values are not allowed.
- */
- int procedureNoNulls = 0;
- /**
- * NULL values are allowed.
- */
- int procedureNullable = 1;
- /**
- * It is unknown whether or not NULL values are allowed.
- */
- int procedureNullableUnknown = 2;
- /**
- * The column does not allow NULL
- */
- int columnNoNulls = 0;
- /**
- * The column does allow NULL
- */
- int columnNullable = 1;
- /**
- * It is unknown whether or not the column allows NULL
- */
- int columnNullableUnknown = 2;
- /**
- * The best row's scope is only guaranteed to be valid so long as the
- * row is actually being used.
- */
- int bestRowTemporary = 0;
- /**
- * The best row identifier is valid to the end of the transaction.
- */
- int bestRowTransaction = 1;
- /**
- * The best row identifier is valid to the end of the session.
- */
- int bestRowSession = 2;
- /**
- * The best row may or may not be a pseudo-column.
- */
- int bestRowUnknown = 0;
- /**
- * The best row identifier is not a pseudo-column.
- */
- int bestRowNotPseudo = 1;
- /**
- * The best row identifier is a pseudo-column.
- */
- int bestRowPseudo = 2;
- /**
- * It is unknown whether or not the version column is a pseudo-column.
- */
- int versionColumnUnknown = 0;
- /**
- * The version column is not a pseudo-column
- */
- int versionColumnNotPseudo = 1;
- /**
- * The version column is a pseudo-column
- */
- int versionColumnPseudo = 2;
- /**
- * Foreign key changes are cascaded in updates or deletes.
- */
- int importedKeyCascade = 0;
- /**
- * Column may not be updated or deleted in use as a foreign key.
- */
- int importedKeyRestrict = 1;
- /**
- * When primary key is updated or deleted, the foreign key is set to NULL.
- */
- int importedKeySetNull = 2;
- /**
- * If the primary key is a foreign key, it cannot be udpated or deleted.
- */
- int importedKeyNoAction = 3;
- /**
- * If the primary key is updated or deleted, the foreign key is set to
- * a default value.
- */
- int importedKeySetDefault = 4;
- /**
- * Wish I knew what this meant.
- */
- int importedKeyInitiallyDeferred = 5;
- /**
- * Wish I knew what this meant.
- */
- int importedKeyInitiallyImmediate = 6;
- /**
- * Wish I knew what this meant.
- */
- int importedKeyNotDeferrable = 7;
- /**
- * A NULL value is not allowed for this data type.
- */
- int typeNoNulls = 0;
- /**
- * A NULL value is allowed for this data type.
- */
- int typeNullable = 1;
- /**
- * It is unknown whether or not NULL values are allowed for this data type.
- */
- int typeNullableUnknown = 2;
- /**
- * Where clauses are not supported for this type.
- */
- int typePredNone = 0;
- /**
- * Only "WHERE..LIKE" style WHERE clauses are allowed on this data type.
- */
- int typePredChar = 1;
- /**
- * All WHERE clauses except "WHERE..LIKE" style are allowed on this data type.
- */
- int typePredBasic = 2;
- /**
- * Any type of WHERE clause is allowed for this data type.
- */
- int typeSearchable = 3;
- /**
- * This column contains table statistics.
- */
- short tableIndexStatistic = 0;
- /**
- * This table index is clustered.
- */
- short tableIndexClustered = 1;
- /**
- * This table index is hashed.
- */
- short tableIndexHashed = 2;
- /**
- * This table index is of another type.
- */
- short tableIndexOther = 3;
- /**
- * A NULL value is not allowed for this attribute.
- */
- short attributeNoNulls = 0;
- /**
- * A NULL value is allowed for this attribute.
- */
- short attributeNullable = 1;
- /**
- * It is unknown whether or not NULL values are allowed for this attribute.
- */
- short attributeNullableUnknown = 2;
- int sqlStateXOpen = 1;
- int sqlStateSQL99 = 2;
- /**
- * This method tests whether or not all the procedures returned by
- * the <code>getProcedures</code> method can be called by this user.
- *
- * @return <code>true</code> if all the procedures can be called,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean allProceduresAreCallable() throws SQLException;
- /**
- * This method tests whether or not all the table returned by the
- * <code>getTables</code> method can be selected by this user.
- *
- * @return <code>true</code> if all the procedures can be called,
- * <code>false</code> otherwise.
- *
- * @exception SQLException If an error occurs.
- */
- boolean allTablesAreSelectable() throws SQLException;
- /**
- * This method returns the URL for this database.
- *
- * @return The URL string for this database, or <code>null</code> if it
- * is not known.
- * @exception SQLException If an error occurs.
- */
- String getURL() throws SQLException;
- /**
- * This method returns the database username for this connection.
- *
- * @return The database username.
- * @exception SQLException If an error occurs.
- */
- String getUserName() throws SQLException;
- /**
- * This method tests whether or not the database is in read only mode.
- *
- * @return <code>true</code> if the database is in read only mode,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean isReadOnly() throws SQLException;
- /**
- * This method tests whether or not NULL's sort as high values.
- *
- * @return <code>true</code> if NULL's sort as high values, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean nullsAreSortedHigh() throws SQLException;
- /**
- * This method tests whether or not NULL's sort as low values.
- *
- * @return <code>true</code> if NULL's sort as low values, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean nullsAreSortedLow() throws SQLException;
- /**
- * This method tests whether or not NULL's sort as high values.
- *
- * @return <code>true</code> if NULL's sort as high values, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean nullsAreSortedAtStart() throws SQLException;
- /**
- * This method test whether or not NULL's are sorted to the end
- * of the list regardless of ascending or descending sort order.
- *
- * @return <code>true</code> if NULL's always sort to the end,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean nullsAreSortedAtEnd() throws SQLException;
- /**
- * This method returns the name of the database product.
- *
- * @return The database product.
- * @exception SQLException If an error occurs.
- */
- String getDatabaseProductName() throws SQLException;
- /**
- * This method returns the version of the database product.
- *
- * @return The version of the database product.
- * @exception SQLException If an error occurs.
- */
- String getDatabaseProductVersion() throws SQLException;
- /**
- * This method returns the name of the JDBC driver.
- *
- * @return The name of the JDBC driver.
- * @exception SQLException If an error occurs.
- */
- String getDriverName() throws SQLException;
- /**
- * This method returns the version of the JDBC driver.
- *
- * @return The version of the JDBC driver.
- * @exception SQLException If an error occurs.
- */
- String getDriverVersion() throws SQLException;
- /**
- * This method returns the major version number of the JDBC driver.
- *
- * @return The major version number of the JDBC driver.
- */
- int getDriverMajorVersion();
- /**
- * This method returns the minor version number of the JDBC driver.
- *
- * @return The minor version number of the JDBC driver.
- */
- int getDriverMinorVersion();
- /**
- * This method tests whether or not the database uses local files to
- * store tables.
- *
- * @return <code>true</code> if the database uses local files,
- * <code>false</code> otherwise.
- *
- * @exception SQLException If an error occurs.
- */
- boolean usesLocalFiles() throws SQLException;
- /**
- * This method tests whether or not the database uses a separate file for
- * each table.
- *
- * @return <code>true</code> if the database uses a separate file for each
- * table <code>false</code> otherwise.
- *
- * @exception SQLException If an error occurs.
- */
- boolean usesLocalFilePerTable() throws SQLException;
- /**
- * This method tests whether or not the database supports identifiers
- * with mixed case.
- *
- * @return <code>true</code> if the database supports mixed case identifiers,
- * <code>false</code> otherwise.
- *
- * @exception SQLException If an error occurs.
- */
- boolean supportsMixedCaseIdentifiers() throws SQLException;
- /**
- * This method tests whether or not the database treats mixed case
- * identifiers as all upper case.
- *
- * @return <code>true</code> if the database treats all identifiers as
- * upper case, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean storesUpperCaseIdentifiers() throws SQLException;
- /**
- * This method tests whether or not the database treats mixed case
- * identifiers as all lower case.
- *
- * @return <code>true</code> if the database treats all identifiers as
- * lower case, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean storesLowerCaseIdentifiers() throws SQLException;
- /**
- * This method tests whether or not the database stores mixed case
- * identifers even if it treats them as case insensitive.
- *
- * @return <code>true</code> if the database stores mixed case identifiers,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean storesMixedCaseIdentifiers() throws SQLException;
- /**
- * This method tests whether or not the database supports quoted identifiers
- * with mixed case.
- *
- * @return <code>true</code> if the database supports mixed case quoted
- * identifiers, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsMixedCaseQuotedIdentifiers() throws SQLException;
- /**
- * This method tests whether or not the database treats mixed case
- * quoted identifiers as all upper case.
- *
- * @return <code>true</code> if the database treats all quoted identifiers
- * as upper case, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean storesUpperCaseQuotedIdentifiers() throws SQLException;
- /**
- * This method tests whether or not the database treats mixed case
- * quoted identifiers as all lower case.
- *
- * @return <code>true</code> if the database treats all quoted identifiers
- * as lower case, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean storesLowerCaseQuotedIdentifiers() throws SQLException;
- /**
- * This method tests whether or not the database stores mixed case
- * quoted identifers even if it treats them as case insensitive.
- *
- * @return <code>true</code> if the database stores mixed case quoted
- * identifiers, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean storesMixedCaseQuotedIdentifiers() throws SQLException;
- /**
- * This metohd returns the quote string for SQL identifiers.
- *
- * @return The quote string for SQL identifers, or a space if quoting
- * is not supported.
- * @exception SQLException If an error occurs.
- */
- String getIdentifierQuoteString() throws SQLException;
- /**
- * This method returns a comma separated list of all the SQL keywords in
- * the database that are not in SQL92.
- *
- * @return The list of SQL keywords not in SQL92.
- * @exception SQLException If an error occurs.
- */
- String getSQLKeywords() throws SQLException;
- /**
- * This method returns a comma separated list of math functions.
- *
- * @return The list of math functions.
- * @exception SQLException If an error occurs.
- */
- String getNumericFunctions() throws SQLException;
- /**
- * This method returns a comma separated list of string functions.
- *
- * @return The list of string functions.
- * @exception SQLException If an error occurs.
- */
- String getStringFunctions() throws SQLException;
- /**
- * This method returns a comma separated list of of system functions.
- *
- * @return A comma separated list of system functions.
- * @exception SQLException If an error occurs.
- */
- String getSystemFunctions() throws SQLException;
- /**
- * This method returns comma separated list of time/date functions.
- *
- * @return The list of time/date functions.
- * @exception SQLException If an error occurs.
- */
- String getTimeDateFunctions() throws SQLException;
- /**
- * This method returns the string used to escape wildcards in search strings.
- *
- * @return The string used to escape wildcards in search strings.
- * @exception SQLException If an error occurs.
- */
- String getSearchStringEscape() throws SQLException;
- /**
- * This methods returns non-standard characters that can appear in
- * unquoted identifiers.
- *
- * @return Non-standard characters that can appear in unquoted identifiers.
- * @exception SQLException If an error occurs.
- */
- String getExtraNameCharacters() throws SQLException;
- /**
- * This method tests whether or not the database supports
- * "ALTER TABLE ADD COLUMN"
- *
- * @return <code>true</code> if column add supported, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsAlterTableWithAddColumn() throws SQLException;
- /**
- * This method tests whether or not the database supports
- * "ALTER TABLE DROP COLUMN"
- *
- * @return <code>true</code> if column drop supported, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsAlterTableWithDropColumn() throws SQLException;
- /**
- * This method tests whether or not column aliasing is supported.
- *
- * @return <code>true</code> if column aliasing is supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsColumnAliasing() throws SQLException;
- /**
- * This method tests whether the concatenation of a NULL and non-NULL
- * value results in a NULL. This will always be true in fully JDBC compliant
- * drivers.
- *
- * @return <code>true</code> if concatenating NULL and a non-NULL value
- * returns a NULL, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean nullPlusNonNullIsNull() throws SQLException;
- /**
- * Tests whether or not CONVERT is supported.
- *
- * @return <code>true</code> if CONVERT is supported, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsConvert() throws SQLException;
- /**
- * This method tests whether or not CONVERT can be performed between the
- * specified types. The types are contants from <code>Types</code>.
- *
- * @param fromType The SQL type to convert from.
- * @param toType The SQL type to convert to.
- * @return <code>true</code> if the conversion can be performed,
- * <code>false</code> otherwise.
- * @see Types
- */
- boolean supportsConvert(int fromType, int toType) throws
- SQLException;
- /**
- * This method tests whether or not table correlation names are
- * supported. This will be always be <code>true</code> in a fully JDBC
- * compliant driver.
- *
- * @return <code>true</code> if table correlation names are supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsTableCorrelationNames() throws SQLException;
- /**
- * This method tests whether correlation names must be different from the
- * name of the table.
- *
- * @return <code>true</code> if the correlation name must be different from
- * the table name, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsDifferentTableCorrelationNames() throws SQLException;
- /**
- * This method tests whether or not expressions are allowed in an
- * ORDER BY lists.
- *
- * @return <code>true</code> if expressions are allowed in ORDER BY
- * lists, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsExpressionsInOrderBy() throws SQLException;
- /**
- * This method tests whether or ORDER BY on a non-selected column is
- * allowed.
- *
- * @return <code>true</code> if a non-selected column can be used in an
- * ORDER BY, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsOrderByUnrelated() throws SQLException;
- /**
- * This method tests whether or not GROUP BY is supported.
- *
- * @return <code>true</code> if GROUP BY is supported, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsGroupBy() throws SQLException;
- /**
- * This method tests whether GROUP BY on a non-selected column is
- * allowed.
- *
- * @return <code>true</code> if a non-selected column can be used in a
- * GROUP BY, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsGroupByUnrelated() throws SQLException;
- /**
- * This method tests whether or not a GROUP BY can add columns not in the
- * select if it includes all the columns in the select.
- *
- * @return <code>true</code> if GROUP BY an add columns provided it includes
- * all columns in the select, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsGroupByBeyondSelect() throws SQLException;
- /**
- * This method tests whether or not the escape character is supported in
- * LIKE expressions. A fully JDBC compliant driver will always return
- * <code>true</code>.
- *
- * @return <code>true</code> if escapes are supported in LIKE expressions,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsLikeEscapeClause() throws SQLException;
- /**
- * This method tests whether multiple result sets for a single statement are
- * supported.
- *
- * @return <code>true</code> if multiple result sets are supported for a
- * single statement, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsMultipleResultSets() throws SQLException;
- /**
- * This method test whether or not multiple transactions may be open
- * at once, as long as they are on different connections.
- *
- * @return <code>true</code> if multiple transactions on different
- * connections are supported, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsMultipleTransactions() throws SQLException;
- /**
- * This method tests whether or not columns can be defined as NOT NULL. A
- * fully JDBC compliant driver always returns <code>true</code>.
- *
- * @return <code>true</code> if NOT NULL columns are supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsNonNullableColumns() throws SQLException;
- /**
- * This method tests whether or not the minimum grammer for ODBC is supported.
- * A fully JDBC compliant driver will always return <code>true</code>.
- *
- * @return <code>true</code> if the ODBC minimum grammar is supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsMinimumSQLGrammar() throws SQLException;
- /**
- * This method tests whether or not the core grammer for ODBC is supported.
- *
- * @return <code>true</code> if the ODBC core grammar is supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsCoreSQLGrammar() throws SQLException;
- /**
- * This method tests whether or not the extended grammer for ODBC is supported.
- *
- * @return <code>true</code> if the ODBC extended grammar is supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsExtendedSQLGrammar() throws SQLException;
- /**
- * This method tests whether or not the ANSI92 entry level SQL
- * grammar is supported. A fully JDBC compliant drivers must return
- * <code>true</code>.
- *
- * @return <code>true</code> if the ANSI92 entry level SQL grammar is
- * supported, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsANSI92EntryLevelSQL() throws SQLException;
- /**
- * This method tests whether or not the ANSI92 intermediate SQL
- * grammar is supported.
- *
- * @return <code>true</code> if the ANSI92 intermediate SQL grammar is
- * supported, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsANSI92IntermediateSQL() throws SQLException;
- /**
- * This method tests whether or not the ANSI92 full SQL
- * grammar is supported.
- *
- * @return <code>true</code> if the ANSI92 full SQL grammar is
- * supported, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsANSI92FullSQL() throws SQLException;
- /**
- * This method tests whether or not the SQL integrity enhancement
- * facility is supported.
- *
- * @return <code>true</code> if the integrity enhancement facility is
- * supported, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsIntegrityEnhancementFacility() throws SQLException;
- /**
- * This method tests whether or not the database supports outer joins.
- *
- * @return <code>true</code> if outer joins are supported, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsOuterJoins() throws SQLException;
- /**
- * This method tests whether or not the database supports full outer joins.
- *
- * @return <code>true</code> if full outer joins are supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsFullOuterJoins() throws SQLException;
- /**
- * This method tests whether or not the database supports limited outer joins.
- *
- * @return <code>true</code> if limited outer joins are supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsLimitedOuterJoins() throws SQLException;
- /**
- * This method returns the vendor's term for "schema".
- *
- * @return The vendor's term for schema.
- * @exception SQLException if an error occurs.
- */
- String getSchemaTerm() throws SQLException;
- /**
- * This method returns the vendor's term for "procedure".
- *
- * @return The vendor's term for procedure.
- * @exception SQLException if an error occurs.
- */
- String getProcedureTerm() throws SQLException;
- /**
- * This method returns the vendor's term for "catalog".
- *
- * @return The vendor's term for catalog.
- * @exception SQLException if an error occurs.
- */
- String getCatalogTerm() throws SQLException;
- /**
- * This method tests whether a catalog name appears at the beginning of
- * a fully qualified table name.
- *
- * @return <code>true</code> if the catalog name appears at the beginning,
- * <code>false</code> if it appears at the end.
- * @exception SQLException If an error occurs.
- */
- boolean isCatalogAtStart() throws SQLException;
- /**
- * This method returns the separator between the catalog name and the
- * table name.
- *
- * @return The separator between the catalog name and the table name.
- * @exception SQLException If an error occurs.
- */
- String getCatalogSeparator() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in a data
- * manipulation statement.
- *
- * @return <code>true</code> if a catalog name can appear in a data
- * manipulation statement, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSchemasInDataManipulation() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in a procedure
- * call
- *
- * @return <code>true</code> if a catalog name can appear in a procedure
- * call, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSchemasInProcedureCalls() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in a table definition.
- *
- * @return <code>true</code> if a catalog name can appear in a table
- * definition, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSchemasInTableDefinitions() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in an index definition.
- *
- * @return <code>true</code> if a catalog name can appear in an index
- * definition, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSchemasInIndexDefinitions() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in privilege definitions.
- *
- * @return <code>true</code> if a catalog name can appear in privilege
- * definition, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSchemasInPrivilegeDefinitions() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in a data
- * manipulation statement.
- *
- * @return <code>true</code> if a catalog name can appear in a data
- * manipulation statement, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsCatalogsInDataManipulation() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in a procedure
- * call
- *
- * @return <code>true</code> if a catalog name can appear in a procedure
- * call, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsCatalogsInProcedureCalls() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in a table definition.
- *
- * @return <code>true</code> if a catalog name can appear in a table
- * definition, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsCatalogsInTableDefinitions() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in an index definition.
- *
- * @return <code>true</code> if a catalog name can appear in an index
- * definition, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsCatalogsInIndexDefinitions() throws SQLException;
- /**
- * This method tests whether a catalog name can appear in privilege definitions.
- *
- * @return <code>true</code> if a catalog name can appear in privilege
- * definition, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException;
- /**
- * This method tests whether or not that database supports positioned
- * deletes.
- *
- * @return <code>true</code> if positioned deletes are supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsPositionedDelete() throws SQLException;
- /**
- * This method tests whether or not that database supports positioned
- * updates.
- *
- * @return <code>true</code> if positioned updates are supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsPositionedUpdate() throws SQLException;
- /**
- * This method tests whether or not SELECT FOR UPDATE is supported by the
- * database.
- *
- * @return <code>true</code> if SELECT FOR UPDATE is supported
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSelectForUpdate() throws SQLException;
- /**
- * This method tests whether or not stored procedures are supported on
- * this database.
- *
- * @return <code>true</code> if stored procedures are supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsStoredProcedures() throws SQLException;
- /**
- * This method tests whether or not subqueries are allowed in comparisons.
- * A fully JDBC compliant driver will always return <code>true</code>.
- *
- * @return <code>true</code> if subqueries are allowed in comparisons,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSubqueriesInComparisons() throws SQLException;
- /**
- * This method tests whether or not subqueries are allowed in exists
- * expressions. A fully JDBC compliant driver will always return
- * <code>true</code>.
- *
- * @return <code>true</code> if subqueries are allowed in exists
- * expressions, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSubqueriesInExists() throws SQLException;
- /**
- * This method tests whether subqueries are allowed in IN statements.
- * A fully JDBC compliant driver will always return <code>true</code>.
- *
- * @return <code>true</code> if the driver supports subqueries in IN
- * statements, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSubqueriesInIns() throws SQLException;
- /**
- * This method tests whether or not subqueries are allowed in quantified
- * expressions. A fully JDBC compliant driver will always return
- * <code>true</code>.
- *
- * @return <code>true</code> if subqueries are allowed in quantified
- * expressions, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsSubqueriesInQuantifieds() throws SQLException;
- /**
- * This method test whether or not correlated subqueries are allowed. A
- * fully JDBC compliant driver will always return <code>true</code>.
- *
- * @return <code>true</code> if correlated subqueries are allowed,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsCorrelatedSubqueries() throws SQLException;
- /**
- * This method tests whether or not the UNION statement is supported.
- *
- * @return <code>true</code> if UNION is supported, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsUnion() throws SQLException;
- /**
- * This method tests whether or not the UNION ALL statement is supported.
- *
- * @return <code>true</code> if UNION ALL is supported, <code>false</code>
- * otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsUnionAll() throws SQLException;
- /**
- * This method tests whether or not the database supports cursors
- * remaining open across commits.
- *
- * @return <code>true</code> if cursors can remain open across commits,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsOpenCursorsAcrossCommit() throws SQLException;
- /**
- * This method tests whether or not the database supports cursors
- * remaining open across rollbacks.
- *
- * @return <code>true</code> if cursors can remain open across rollbacks,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsOpenCursorsAcrossRollback() throws SQLException;
- /**
- * This method tests whether or not the database supports statements
- * remaining open across commits.
- *
- * @return <code>true</code> if statements can remain open across commits,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsOpenStatementsAcrossCommit() throws SQLException;
- /**
- * This method tests whether or not the database supports statements
- * remaining open across rollbacks.
- *
- * @return <code>true</code> if statements can remain open across rollbacks,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsOpenStatementsAcrossRollback() throws SQLException;
- /**
- * This method returns the number of hex characters allowed in an inline
- * binary literal.
- *
- * @return The number of hex characters allowed in a binary literal, 0 meaning
- * either an unknown or unlimited number.
- * @exception SQLException If an error occurs.
- */
- int getMaxBinaryLiteralLength() throws SQLException;
- /**
- * This method returns the maximum length of a character literal.
- *
- * @return The maximum length of a character literal.
- * @exception SQLException If an error occurs.
- */
- int getMaxCharLiteralLength() throws SQLException;
- /**
- * This method returns the maximum length of a column name.
- *
- * @return The maximum length of a column name.
- * @exception SQLException If an error occurs.
- */
- int getMaxColumnNameLength() throws SQLException;
- /**
- * This method returns the maximum number of columns in a GROUP BY statement.
- *
- * @return The maximum number of columns in a GROUP BY statement.
- * @exception SQLException If an error occurs.
- */
- int getMaxColumnsInGroupBy() throws SQLException;
- /**
- * This method returns the maximum number of columns in an index.
- *
- * @return The maximum number of columns in an index.
- * @exception SQLException If an error occurs.
- */
- int getMaxColumnsInIndex() throws SQLException;
- /**
- * This method returns the maximum number of columns in an ORDER BY statement.
- *
- * @return The maximum number of columns in an ORDER BY statement.
- * @exception SQLException If an error occurs.
- */
- int getMaxColumnsInOrderBy() throws SQLException;
- /**
- * This method returns the maximum number of columns in a SELECT statement.
- *
- * @return The maximum number of columns in a SELECT statement.
- * @exception SQLException If an error occurs.
- */
- int getMaxColumnsInSelect() throws SQLException;
- /**
- * This method returns the maximum number of columns in a table.
- *
- * @return The maximum number of columns in a table.
- * @exception SQLException If an error occurs.
- */
- int getMaxColumnsInTable() throws SQLException;
- /**
- * This method returns the maximum number of connections this client
- * can have to the database.
- *
- * @return The maximum number of database connections.
- * @SQLException If an error occurs.
- */
- int getMaxConnections() throws SQLException;
- /**
- * This method returns the maximum length of a cursor name.
- *
- * @return The maximum length of a cursor name.
- * @exception SQLException If an error occurs.
- */
- int getMaxCursorNameLength() throws SQLException;
- /**
- * This method returns the maximum length of an index.
- *
- * @return The maximum length of an index.
- * @exception SQLException If an error occurs.
- */
- int getMaxIndexLength() throws SQLException;
- /**
- * This method returns the maximum length of a schema name.
- *
- * @return The maximum length of a schema name.
- * @exception SQLException If an error occurs.
- */
- int getMaxSchemaNameLength() throws SQLException;
- /**
- * This method returns the maximum length of a procedure name.
- *
- * @return The maximum length of a procedure name.
- * @exception SQLException If an error occurs.
- */
- int getMaxProcedureNameLength() throws SQLException;
- /**
- * This method returns the maximum length of a catalog name.
- *
- * @return The maximum length of a catalog name.
- * @exception SQLException If an error occurs.
- */
- int getMaxCatalogNameLength() throws SQLException;
- /**
- * This method returns the maximum size of a row in bytes.
- *
- * @return The maximum size of a row.
- * @exception SQLException If an error occurs.
- */
- int getMaxRowSize() throws SQLException;
- /**
- * This method tests whether or not the maximum row size includes BLOB's
- *
- * @return <code>true</code> if the maximum row size includes BLOB's,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean doesMaxRowSizeIncludeBlobs() throws SQLException;
- /**
- * This method includes the maximum length of a SQL statement.
- *
- * @return The maximum length of a SQL statement.
- * @exception SQLException If an error occurs.
- */
- int getMaxStatementLength() throws SQLException;
- /**
- * This method returns the maximum number of statements that can be
- * active at any time.
- *
- * @return The maximum number of statements that can be active at any time.
- * @exception SQLException If an error occurs.
- */
- int getMaxStatements() throws SQLException;
- /**
- * This method returns the maximum length of a table name.
- *
- * @return The maximum length of a table name.
- * @exception SQLException If an error occurs.
- */
- int getMaxTableNameLength() throws SQLException;
- /**
- * This method returns the maximum number of tables that may be referenced
- * in a SELECT statement.
- *
- * @return The maximum number of tables allowed in a SELECT statement.
- * @exception SQLException If an error occurs.
- */
- int getMaxTablesInSelect() throws SQLException;
- /**
- * This method returns the maximum length of a user name.
- *
- * @return The maximum length of a user name.
- * @exception SQLException If an error occurs.
- */
- int getMaxUserNameLength() throws SQLException;
- /**
- * This method returns the default transaction isolation level of the
- * database.
- *
- * @return The default transaction isolation level of the database.
- * @exception SQLException If an error occurs.
- * @see Connection
- */
- int getDefaultTransactionIsolation() throws SQLException;
- /**
- * This method tests whether or not the database supports transactions.
- *
- * @return <code>true</code> if the database supports transactions,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsTransactions() throws SQLException;
- /**
- * This method tests whether or not the database supports the specified
- * transaction isolation level.
- *
- * @param level The transaction isolation level.
- *
- * @return <code>true</code> if the specified transaction isolation level
- * is supported, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsTransactionIsolationLevel(int level) throws
- SQLException;
- /**
- * This method tests whether or not DDL and DML statements allowed within
- * the same transaction.
- *
- * @return <code>true</code> if DDL and DML statements are allowed in the
- * same transaction, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsDataDefinitionAndDataManipulationTransactions()
- throws SQLException;
- /**
- * This method tests whether or not only DML statement are allowed
- * inside a transaction.
- *
- * @return <code>true</code> if only DML statements are allowed in
- * transactions, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsDataManipulationTransactionsOnly() throws
- SQLException;
- /**
- * This method tests whether or not a DDL statement will cause the
- * current transaction to be automatically committed.
- *
- * @return <code>true</code> if DDL causes an immediate transaction commit,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean dataDefinitionCausesTransactionCommit() throws SQLException;
- /**
- * This method tests whether or not DDL statements are ignored in
- * transactions.
- *
- * @return <code>true</code> if DDL statements are ignored in transactions,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean dataDefinitionIgnoredInTransactions() throws SQLException;
- /**
- * This method returns a list of all the stored procedures matching the
- * specified pattern in the given schema and catalog. This is returned
- * a <code>ResultSet</code> with the following columns:
- * <p>
- * <ol>
- * <li>PROCEDURE_CAT - The catalog the procedure is in, which may be
- * <code>null</code>.</li>
- * <li>PROCEDURE_SCHEM - The schema the procedures is in, which may be
- * <code>null</code>.</li>
- * <li>PROCEDURE_NAME - The name of the procedure.</li>
- * <li>Unused</li>
- * <li>Unused</li>
- * <li>Unused</li>
- * <li>REMARKS - A description of the procedure</li>
- * <li>PROCEDURE_TYPE - Indicates the return type of the procedure, which
- * is one of the contstants defined in this class
- * (<code>procedureResultUnknown</code>, <code>procedureNoResult</code>, or
- * <code>procedureReturnsResult</code>).</li>
- * </ol>
- *
- * @param catalog The name of the catalog to return stored procedured from,
- * or "" to return procedures from all catalogs.
- * @param schemaPattern A schema pattern for the schemas to return stored
- * procedures from, or "" to return procedures from all schemas.
- * @param procedurePattern The pattern of procedure names to return.
- * @returns A <code>ResultSet</code> with all the requested procedures.
- * @exception SQLException If an error occurs.
- */
- ResultSet getProcedures(String catalog, String schemaPattern, String
- procedurePattern) throws SQLException;
- /**
- * This method returns a list of the parameter and result columns for
- * the requested stored procedures. This is returned in the form of a
- * <code>ResultSet</code> with the following columns:
- * <p>
- * <ol>
- * <li>PROCEDURE_CAT - The catalog the procedure is in, which may be
- * <code>null</code>.</li>
- * <li>PROCEDURE_SCHEM - The schema the procedures is in, which may be
- * <code>null</code>.</li>
- * <li>PROCEDURE_NAME - The name of the procedure.</li>
- * <li>COLUMN_NAME - The name of the column</li>
- * <li>COLUMN_TYPE - The type of the column, which will be one of the
- * contants defined in this class (<code>procedureColumnUnknown</code>,
- * <code>procedureColumnIn</code>, <code>procedureColumnInOut</code>,
- * <code>procedureColumnOut</code>, <code>procedureColumnReturn</code>,
- * or <code>procedureColumnResult</code>).</li>
- * <li>DATA_TYPE - The SQL type of the column. This is one of the constants
- * defined in <code>Types</code>.</li>
- * <li>TYPE_NAME - The string name of the data type for this column.</li>
- * <li>PRECISION - The precision of the column.</li>
- * <li>LENGTH - The length of the column in bytes</li>
- * <li>SCALE - The scale of the column.</li>
- * <li>RADIX - The radix of the column.</li>
- * <li>NULLABLE - Whether or not the column is NULLABLE. This is one of
- * the constants defined in this class (<code>procedureNoNulls</code>,
- * <code>procedureNullable</code>, or <code>procedureNullableUnknown</code>)</li>
- * <li>REMARKS - A description of the column.</li>
- * </ol>
- *
- * @param catalog The name of the catalog to return stored procedured from,
- * or "" to return procedures from all catalogs.
- * @param schemaPattern A schema pattern for the schemas to return stored
- * procedures from, or "" to return procedures from all schemas.
- * @param procedurePattern The pattern of procedures names to return.
- * @param columnPattern The pattern of column names to return.
- * @returns A <code>ResultSet</code> with all the requested procedures.
- * @exception SQLException If an error occurs.
- */
- ResultSet getProcedureColumns(String catalog, String schemaPattern,
- String procedurePattern, String columnPattern) throws
- SQLException;
- /**
- * This method returns a list of the requested table as a
- * <code>ResultSet</code> with the following columns:
- *
- * <ol>
- * <li>TABLE_CAT - The catalog the table is in, which may be <code>null</code>.</li>
- * <li>TABLE_SCHEM - The schema the table is in, which may be <code>null</code>.</li>
- * <li>TABLE_NAME - The name of the table.</li>
- * <li>TABLE_TYPE - A string describing the table type. This will be one
- * of the values returned by the <code>getTableTypes()</code> method.</li>
- * <li>REMARKS - Comments about the table.</li>
- * </ol>
- *
- * @param catalog The name of the catalog to return tables from,
- * or "" to return tables from all catalogs.
- * @param schemaPattern A schema pattern for the schemas to return tables
- * from, or "" to return tables from all schemas.
- * @param tablePattern The pattern of table names to return.
- * @param types The list of table types to include; null returns all types.
- * @returns A <code>ResultSet</code> with all the requested tables.
- * @exception SQLException If an error occurs.
- */
- ResultSet getTables(String catalog, String schemaPattern, String
- tablePattern, String[] types) throws SQLException;
- /**
- * This method returns the list of database schemas as a
- * <code>ResultSet</code>, with one column - TABLE_SCHEM - that is the
- * name of the schema.
- *
- * @return A <code>ResultSet</code> with all the requested schemas.
- * @exception SQLException If an error occurs.
- */
- ResultSet getSchemas() throws SQLException;
- /**
- * This method returns the list of database catalogs as a
- * <code>ResultSet</code> with one column - TABLE_CAT - that is the
- * name of the catalog.
- *
- * @return A <code>ResultSet</code> with all the requested catalogs.
- * @exception SQLException If an error occurs.
- */
- ResultSet getCatalogs() throws SQLException;
- /**
- * This method returns the list of database table types as a
- * <code>ResultSet</code> with one column - TABLE_TYPE - that is the
- * name of the table type.
- *
- * @return A <code>ResultSet</code> with all the requested table types.
- * @exception SQLException If an error occurs.
- */
- ResultSet getTableTypes() throws SQLException;
- /**
- * This method returns a list of the tables columns for
- * the requested tables. This is returned in the form of a
- * <code>ResultSet</code> with the following columns:
- * <p>
- * <ol>
- * <li>TABLE_CAT - The catalog the table is in, which may be
- * <code>null</code>.</li>
- * <li>TABLE_SCHEM - The schema the tables is in, which may be
- * <code>null</code>.</li>
- * <li>TABLE_NAME - The name of the table.</li>
- * <li>COLUMN_NAME - The name of the column</li>
- * <li>DATA_TYPE - The SQL type of the column. This is one of the constants
- * defined in <code>Types</code>.</li>
- * <li>TYPE_NAME - The string name of the data type for this column.</li>
- * <li>COLUMN_SIZE - The size of the column.</li>
- * <li>Unused</li>
- * <li>NUM_PREC_RADIX - The radix of the column.</li>
- * <li>NULLABLE - Whether or not the column is NULLABLE. This is one of
- * the constants defined in this class (<code>tableNoNulls</code>,
- * <code>tableNullable</code>, or <code>tableNullableUnknown</code>)</li>
- * <li>REMARKS - A description of the column.</li>
- * <li>COLUMN_DEF - The default value for the column, may be <code>null</code>.</li>
- * <li>SQL_DATA_TYPE - Unused</li>
- * <li>SQL_DATETIME_SUB - Unused</li>
- * <li>CHAR_OCTET_LENGTH - For character columns, the maximum number of bytes
- * in the column.</li>
- * <li>ORDINAL_POSITION - The index of the column in the table.</li>
- * <li>IS_NULLABLE - "NO" means no, "YES" means maybe, and an empty string
- * means unknown.</li>
- * </ol>
- *
- * @param catalog The name of the catalog to return table from,
- * or "" to return tables from all catalogs.
- * @param schemaPattern A schema pattern for the schemas to return
- * tables from, or "" to return tables from all schemas.
- * @param tablePattern The pattern of table names to return.
- * @param columnPattern The pattern of column names to return.
- * @returns A <code>ResultSet</code> with all the requested tables.
- * @exception SQLException If an error occurs.
- */
- ResultSet getColumns(String catalog, String schemaPattern, String
- tablePattern, String columnPattern) throws SQLException;
- /**
- * This method returns the access rights that have been granted to the
- * requested columns. This information is returned as a <code>ResultSet</code>
- * with the following columns:
- *
- * <ol>
- * <li>TABLE_CAT - The catalog the table is in, which may be
- * <code>null</code>.</li>
- * <li>TABLE_SCHEM - The schema the tables is in, which may be
- * <code>null</code>.</li>
- * <li>TABLE_NAME - The name of the table.</li>
- * <li>COLUMN_NAME - The name of the column.</li>
- * <li>GRANTOR - The entity that granted the access.</li>
- * <li>GRANTEE - The entity granted the access.</li>
- * <li>PRIVILEGE - The name of the privilege granted.</li>
- * <li>IS_GRANTABLE - "YES" if the grantee can grant the privilege to
- * others, "NO" if not, and <code>null</code> if unknown.</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or <code>null</code>
- * to return information from all catalogs.
- * @param schema The schema to retrieve information from, or the empty string
- * to return entities not associated with a schema.
- * @param tableName The table name to return information for.
- * @param columnPattern A pattern of column names to return information for.
- * @return A <code>ResultSet</code> with all the requested privileges.
- * @exception SQLException If an error occurs.
- */
- ResultSet getColumnPrivileges(String catalog, String schema, String
- tableName, String columnPattern) throws SQLException;
- /**
- * This method returns the access rights that have been granted to the
- * requested tables. This information is returned as a <code>ResultSet</code>
- * with the following columns:
- *
- * <ol>
- * <li>TABLE_CAT - The catalog the table is in, which may be
- * <code>null</code>.</li>
- * <li>TABLE_SCHEM - The schema the tables is in, which may be
- * <code>null</code>.</li>
- * <li>TABLE_NAME - The name of the table.</li>
- * <li>GRANTOR - The entity that granted the access.</li>
- * <li>GRANTEE - The entity granted the access.</li>
- * <li>PRIVILEGE - The name of the privilege granted.</li>
- * <li>IS_GRANTABLE - "YES" if the grantee can grant the privilege to
- * others, "NO" if not, and <code>null</code> if unknown.</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or <code>null</code>
- * to return information from all catalogs.
- * @param schemaPattern The schema to retrieve information from, or the empty string
- * to return entities not associated with a schema.
- * @param tablePattern The table name pattern of tables to return
- * information for.
- * @return A <code>ResultSet</code> with all the requested privileges.
- * @exception SQLException If an error occurs.
- */
- ResultSet getTablePrivileges(String catalog, String schemaPattern,
- String tablePattern) throws SQLException;
- /**
- * This method returns the best set of columns for uniquely identifying
- * a row. It returns this information as a <code>ResultSet</code> with
- * the following columns:
- *
- * <ol>
- * <li>SCOPE - The scope of the results returned. This is one of the
- * constants defined in this class (<code>bestRowTemporary</code>,
- * <code>bestRowTransaction</code>, or <code>bestRowSession</code>).</li>
- * <li>COLUMN_NAME - The name of the column.</li>
- * <li>DATA_TYPE - The SQL type of the column. This is one of the constants
- * defined in <code>Types</code>.</li>
- * <li>TYPE_NAME - The string name of the data type for this column.</li>
- * <li>COLUMN_SIZE - The precision of the columns</li>
- * <li>BUFFER_LENGTH - Unused</li>
- * <li>DECIMAL_DIGITS - The scale of the column.</li>
- * <li>PSEUDO_COLUMN - Whether or not the best row identifier is a
- * pseudo_column. This is one of the constants defined in this class
- * (<code>bestRowUnknown</code>, <code>bestRowNotPseudo</code>, or
- * <code>bestRowPseudo</code>).</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or <code>null</code>
- * to return information from all catalogs.
- * @param schema The schema to retrieve information from, or the empty string
- * to return entities not associated with a schema.
- * @param tableName The table name to return information for.
- * @param scope One of the best row id scope constants from this class.
- * @param nullable <code>true</code> to include columns that are nullable,
- * <code>false</code> otherwise.
- * @return A <code>ResultSet</code> with the best row identifier.
- * @exception SQLException If an error occurs.
- */
- ResultSet getBestRowIdentifier(String catalog, String schema,
- String tableName, int scope, boolean nullable) throws SQLException;
- /**
- * This method returns the set of columns that are automatically updated
- * when the row is update. It returns this information as a
- * <code>ResultSet</code> with the following columns:
- *
- * <ol>
- * <li>SCOPE - Unused</li>
- * <li>COLUMN_NAME - The name of the column.</li>
- * <li>DATA_TYPE - The SQL type of the column. This is one of the constants
- * defined in <code>Types</code>.</li>
- * <li>TYPE_NAME - The string name of the data type for this column.</li>
- * <li>COLUMN_SIZE - The precision of the columns</li>
- * <li>BUFFER_LENGTH - Unused</li>
- * <li>DECIMAL_DIGITS - The scale of the column.</li>
- * <li>PSEUDO_COLUMN - Whether or not the best row identifier is a
- * pseudo_column. This is one of the constants defined in this class
- * (<code>versionRowUnknown</code>, <code>versionRowNotPseudo</code>, or
- * <code>versionRowPseudo</code>).</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or <code>null</code>
- * to return information from all catalogs.
- * @param schema The schema to retrieve information from, or the empty string
- * to return entities not associated with a schema.
- * @param tableName The table name to return information for
- * @return A <code>ResultSet</code> with the version columns.
- * @exception SQLException If an error occurs.
- */
- ResultSet getVersionColumns(String catalog, String schema,
- String tableName) throws SQLException;
- /**
- * This method returns a list of a table's primary key columns. These
- * are returned as a <code>ResultSet</code> with the following columns.
- *
- * <ol>
- * <li>TABLE_CAT - The catalog of the table, which may be <code>null</code>.</li>
- * <li>TABLE_SCHEM - The schema of the table, which may be <code>null</code>.</li>
- * <li>TABLE_NAME - The name of the table.</li>
- * <li>COLUMN_NAME - The name of the column.</li>
- * <li>KEY_SEQ - The sequence number of the column within the primary key.</li>
- * <li>PK_NAME - The name of the primary key, which may be <code>null</code>.</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or <code>null</code>
- * to return information from all catalogs.
- * @param schema The schema to retrieve information from, or the empty string
- * to return entities not associated with a schema.
- * @param tableName The table name to return information for.
- * @return A <code>ResultSet</code> with the primary key columns.
- * @exception SQLException If an error occurs.
- */
- ResultSet getPrimaryKeys(String catalog, String schema, String tableName)
- throws SQLException;
- /**
- * This method returns a list of the table's foreign keys. These are
- * returned as a <code>ResultSet</code> with the following columns:
- *
- * <ol>
- * <li>PKTABLE_CAT - The catalog of the table the key was imported from.</li>
- * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.</li>
- * <li>PKTABLE_NAME - The name of the table the key was imported from.</li>
- * <li>PKCOLUMN_NAME - The name of the column that was imported.</li>
- * <li>FKTABLE_CAT - The foreign key catalog name.</li>
- * <li>FKTABLE_SCHEM - The foreign key schema name.</li>
- * <li>FKTABLE_NAME - The foreign key table name.</li>
- * <li>FKCOLUMN_NAME - The foreign key column name.</li>
- * <li>KEY_SEQ - The sequence number of the column within the foreign key.</li>
- * <li>UPDATE_RULE - How the foreign key behaves when the primary key is
- * updated. This is one of the constants defined in this class
- * (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, <code>importedKeySetDefault</code>, or
- * <code>importedKeyRestrict</code>).</li>
- * <li>DELETE_RULE - How the foreign key behaves when the primary key is
- * deleted. This is one of the constants defined in this class
- * (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)</li>
- * <li>FK_NAME - The name of the foreign key.</li>
- * <li>PK_NAME - The name of the primary key.</li>
- * <li>DEFERRABILITY - The deferrability value. This is one of the
- * constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
- * <code>importedKeyInitiallyImmediate</code>, or
- * <code>importedKeyNotDeferrable</code>).</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or <code>null</code>
- * to return information from all catalogs.
- * @param schema The schema to retrieve information from, or the empty string
- * to return entities not associated with a schema.
- * @param tableName The table name to return information for.
- * @return A <code>ResultSet</code> with the foreign key columns.
- * @exception SQLException If an error occurs.
- */
- ResultSet getImportedKeys(String catalog, String schema,
- String tableName) throws SQLException;
- /**
- * This method returns a list of the table's which use this table's
- * primary key as a foreign key. The information is
- * returned as a <code>ResultSet</code> with the following columns:
- *
- * <ol>
- * <li>PKTABLE_CAT - The catalog of the table the key was imported from.</li>
- * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.</li>
- * <li>PKTABLE_NAME - The name of the table the key was imported from.</li>
- * <li>PKCOLUMN_NAME - The name of the column that was imported.</li>
- * <li>FKTABLE_CAT - The foreign key catalog name.</li>
- * <li>FKTABLE_SCHEM - The foreign key schema name.</li>
- * <li>FKTABLE_NAME - The foreign key table name.</li>
- * <li>FKCOLUMN_NAME - The foreign key column name.</li>
- * <li>KEY_SEQ - The sequence number of the column within the foreign key.</li>
- * <li>UPDATE_RULE - How the foreign key behaves when the primary key is
- * updated. This is one of the constants defined in this class
- * (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, <code>importedKeySetDefault</code>, or
- * <code>importedKeyRestrict</code>).</li>
- * <li>DELETE_RULE - How the foreign key behaves when the primary key is
- * deleted. This is one of the constants defined in this class
- * (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)</li>
- * <li>FK_NAME - The name of the foreign key.</li>
- * <li>PK_NAME - The name of the primary key.</li>
- * <li>DEFERRABILITY - The deferrability value. This is one of the
- * constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
- * <code>importedKeyInitiallyImmediate</code>, or
- * <code>importedKeyNotDeferrable</code>).</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or <code>null</code>
- * to return information from all catalogs.
- * @param schema The schema to retrieve information from, or the empty string
- * to return entities not associated with a schema.
- * @param tableName The table name to return information for.
- * @return A <code>ResultSet</code> with the requested information
- * @exception SQLException If an error occurs.
- */
- ResultSet getExportedKeys(String catalog, String schema,
- String tableName) throws SQLException;
- /**
- * This method returns a description of how one table imports another
- * table's primary key as a foreign key. The information is
- * returned as a <code>ResultSet</code> with the following columns:
- *
- * <ol>
- * <li>PKTABLE_CAT - The catalog of the table the key was imported from.</li>
- * <li>PKTABLE_SCHEM - The schema of the table the key was imported from.</li>
- * <li>PKTABLE_NAME - The name of the table the key was imported from.</li>
- * <li>PKCOLUMN_NAME - The name of the column that was imported.</li>
- * <li>FKTABLE_CAT - The foreign key catalog name.</li>
- * <li>FKTABLE_SCHEM - The foreign key schema name.</li>
- * <li>FKTABLE_NAME - The foreign key table name.</li>
- * <li>FKCOLUMN_NAME - The foreign key column name.</li>
- * <li>KEY_SEQ - The sequence number of the column within the foreign key.</li>
- * <li>UPDATE_RULE - How the foreign key behaves when the primary key is
- * updated. This is one of the constants defined in this class
- * (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, <code>importedKeySetDefault</code>, or
- * <code>importedKeyRestrict</code>).</li>
- * <li>DELETE_RULE - How the foreign key behaves when the primary key is
- * deleted. This is one of the constants defined in this class
- * (<code>importedNoAction</code>, <code>importedKeyCascade</code>,
- * <code>importedKeySetNull</code>, or <code>importedKeySetDefault</code>)</li>
- * <li>FK_NAME - The name of the foreign key.</li>
- * <li>PK_NAME - The name of the primary key.</li>
- * <li>DEFERRABILITY - The deferrability value. This is one of the
- * constants defined in this table (<code>importedKeyInitiallyDeferred</code>,
- * <code>importedKeyInitiallyImmediate</code>, or
- * <code>importedKeyNotDeferrable</code>).</li>
- * </ol>
- *
- * @param primaryCatalog The catalog to retrieve information from, or the
- * empty string to return entities not associated with a catalog, or
- * <code>null</code> to return information from all catalogs, on the
- * exporting side.
- * @param primarySchema The schema to retrieve information from, or the empty
- * string to return entities not associated with a schema, on the
- * exporting side.
- * @param primaryTableName The table name to return information for, on the
- * exporting side.
- * @param foreignCatalog The catalog to retrieve information from, or the
- * empty string to return entities not associated with a catalog,
- * or <code>null</code> to return information from all catalogs, on
- * the importing side.
- * @param foreignSchema The schema to retrieve information from, or the
- * empty string to return entities not associated with a schema on
- * the importing side.
- * @param foreignTableName The table name to return information for on the
- * importing side.
- * @return A <code>ResultSet</code> with the requested information
- * @exception SQLException If an error occurs.
- */
- ResultSet getCrossReference(String primaryCatalog, String
- primarySchema, String primaryTableName, String foreignCatalog, String
- foreignSchema, String foreignTableName) throws SQLException;
- /**
- * This method returns a list of the SQL types supported by this
- * database. The information is returned as a <code>ResultSet</code>
- * with the following columns:
- *
- * <ol>
- * <li>TYPE_NAME - The name of the data type.</li>
- * <li>DATA_TYPE - A data type constant from <code>Types</code> for this
- * type.</li>
- * <li>PRECISION - The maximum precision of this type.</li>
- * <li>LITERAL_PREFIX - Prefix value used to quote a literal, which may be
- * <code>null</code>.</li>
- * <li>LITERAL_SUFFIX - Suffix value used to quote a literal, which may be
- * <code>null</code>.</li>
- * <li>CREATE_PARAMS - The parameters used to create the type, which may be
- * <code>null</code>.</li>
- * <li>NULLABLE - Whether or not this type supports NULL values. This will
- * be one of the constants defined in this interface
- * (<code>typeNoNulls</code>, <code>typeNullable</code>, or
- * <code>typeNullableUnknown</code>).</li>
- * <li>CASE_SENSITIVE - Whether or not the value is case sensitive.</li>
- * <li>SEARCHABLE - Whether or not "LIKE" expressions are supported in
- * WHERE clauses for this type. This will be one of the constants defined
- * in this interface (<code>typePredNone</code>, <code>typePredChar</code>,
- * <code>typePredBasic</code>, or <code>typeSearchable</code>).</li>
- * <li>UNSIGNED_ATTRIBUTE - Is the value of this type unsigned.</li>
- * <li>FIXED_PREC_SCALE - Whether or not this type can be used for money.</li>
- * <li>AUTO_INCREMENT - Whether or not this type supports auto-incrementing.</li>
- * <li>LOCAL_TYPE_NAME - A localized name for this data type.</li>
- * <li>MINIMUM_SCALE - The minimum scale supported by this type.</li>
- * <li>MAXIMUM_SCALE - The maximum scale supported by this type.</li>
- * <li>SQL_DATA_TYPE - Unused.</li>
- * <li>SQL_DATETIME_SUB - Unused.</li>
- * <li>NUM_PREC_RADIX - The radix of this data type.</li>
- * </ol>
- *
- * @return A <code>ResultSet</code> with the list of available data types.
- * @exception SQLException If an error occurs.
- */
- ResultSet getTypeInfo() throws SQLException;
- /**
- * This method returns information about a tables indices and statistics.
- * It is returned as a <code>ResultSet</code> with the following columns:
- *
- * <ol>
- * <li>TABLE_CAT - The catalog of the table, which may be <code>null</code>.</li>
- * <li>TABLE_SCHEM - The schema of the table, which may be <code>null</code>.</li>
- * <li>TABLE_NAME - The name of the table.</li>
- * <li>NON_UNIQUE - Are index values non-unique?</li>
- * <li>INDEX_QUALIFIER The index catalog, which may be <code>null</code></li>
- * <li>INDEX_NAME - The name of the index.</li>
- * <li>TYPE - The type of index, which will be one of the constants defined
- * in this interface (<code>tableIndexStatistic</code>,
- * <code>tableIndexClustered</code>, <code>tableIndexHashed</code>, or
- * <code>tableIndexOther</code>).</li>
- * <li>ORDINAL_POSITION - The sequence number of this column in the index.
- * This will be 0 when the index type is <code>tableIndexStatistic</code>.</li>
- * <li>COLUMN_NAME - The name of this column in the index.</li>
- * <li>ASC_OR_DESC - "A" for an ascending sort sequence, "D" for a
- * descending sort sequence or <code>null</code> if a sort sequence is not
- * supported.</li>
- * <li>CARDINALITY - The number of unique rows in the index, or the number
- * of rows in the table if the index type is <code>tableIndexStatistic</code>.</li>
- * <li>PAGES - The number of pages used for the index, or the number of pages
- * in the table if the index type is <code>tableIndexStatistic</code>.</li>
- * <li>FILTER_CONDITION - The filter condition for this index, which may be
- * <code>null</code>.</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or
- * <code>null</code> to return information from all catalogs.
- * @param schema The schema to retrieve information from, or the empty string
- * to return entities not associated with a schema.
- * @param tableName The table name to return information for.
- * @param unique <code>true</code> to return only unique indexes,
- * <code>false</code> otherwise.
- * @param approximate <code>true</code> if data values can be approximations,
- * <code>false</code> otherwise.
- * @return A <code>ResultSet</code> with the requested index information
- * @exception SQLException If an error occurs.
- */
- ResultSet getIndexInfo(String catalog, String schema, String tableName,
- boolean unique, boolean approximate) throws SQLException;
- /**
- * This method tests whether or not the datbase supports the specified
- * result type.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- *
- * @return <code>true</code> if the result set type is supported,
- * <code>false</code> otherwise.
- *
- * @exception SQLException If an error occurs.
- *
- * @see ResultSet
- */
- boolean supportsResultSetType(int type) throws SQLException;
- /**
- * This method tests whether the specified result set type and result set
- * concurrency type are supported by the database.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @param concurrency The desired concurrency type, which is one of the
- * constants defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type is supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean supportsResultSetConcurrency(int type, int concurrency)
- throws SQLException;
- /**
- * This method tests whether or not the specified result set type sees its
- * own updates.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type sees its own updates,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean ownUpdatesAreVisible(int type) throws SQLException;
- /**
- * This method tests whether or not the specified result set type sees its
- * own deletes.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type sees its own deletes,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean ownDeletesAreVisible(int type) throws SQLException;
- /**
- * This method tests whether or not the specified result set type sees its
- * own inserts.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type sees its own inserts,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean ownInsertsAreVisible(int type) throws SQLException;
- /**
- * This method tests whether or not the specified result set type sees
- * updates committed by others.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type sees other updates,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean othersUpdatesAreVisible(int type) throws SQLException;
- /**
- * This method tests whether or not the specified result set type sees
- * deletes committed by others.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type sees other deletes,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean othersDeletesAreVisible(int type) throws SQLException;
- /**
- * This method tests whether or not the specified result set type sees
- * inserts committed by others.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type sees other inserts,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean othersInsertsAreVisible(int type) throws SQLException;
- /**
- * This method tests whether or not the specified result set type can detect
- * a visible update by calling the <code>rowUpdated</code> method.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type can detect visible updates
- * using <code>rowUpdated</code>, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean updatesAreDetected(int type) throws SQLException;
- /**
- * This method tests whether or not the specified result set type can detect
- * a visible delete by calling the <code>rowUpdated</code> method.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type can detect visible deletes
- * using <code>rowUpdated</code>, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean deletesAreDetected(int type) throws SQLException;
- /**
- * This method tests whether or not the specified result set type can detect
- * a visible insert by calling the <code>rowUpdated</code> method.
- *
- * @param type The desired result type, which is one of the constants
- * defined in <code>ResultSet</code>.
- * @return <code>true</code> if the result set type can detect visible inserts
- * using <code>rowUpdated</code>, <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- */
- boolean insertsAreDetected(int type) throws SQLException;
- /**
- * This method tests whether or not the database supports batch updates.
- *
- * @return <code>true</code> if batch updates are supported,
- * <code>false</code> otherwise.
- * @exception SQLException If an error occurs.
- */
- boolean supportsBatchUpdates() throws SQLException;
- /**
- * This method returns the list of user defined data types in use. These
- * are returned as a <code>ResultSet</code> with the following columns:
- *
- * <ol>
- * <li>TYPE_CAT - The catalog name, which may be <code>null</code>.</li>
- * <li>TYPE_SCEHM - The schema name, which may be <code>null</code>.</li>
- * <li>TYPE_NAME - The user defined data type name.</li>
- * <li>CLASS_NAME - The Java class name this type maps to.</li>
- * <li>DATA_TYPE - A type identifier from <code>Types</code> for this type.
- * This will be one of <code>JAVA_OBJECT</code>, <code>STRUCT</code>, or
- * <code>DISTINCT</code>.</li>
- * <li>REMARKS - Comments about this data type.</li>
- * </ol>
- *
- * @param catalog The catalog to retrieve information from, or the empty string
- * to return entities not associated with a catalog, or <code>null</code>
- * to return information from all catalogs.
- * @param schemaPattern The schema to retrieve information from, or the
- * empty string to return entities not associated with a schema.
- * @param typePattern The type name pattern to match.
- * @param types The type identifier patterns (from <code>Types</code>) to
- * match.
- * @return A <code>ResultSet</code> with the requested type information
- * @exception SQLException If an error occurs.
- */
- ResultSet getUDTs(String catalog, String schemaPattern, String
- typePattern, int[] types) throws SQLException;
- /**
- * This method returns the <code>Connection</code> object that was used
- * to generate the metadata in this object.
- *
- * @return The connection for this object.
- * @exception SQLException If an error occurs.
- */
- Connection getConnection() throws SQLException;
- /**
- * This method tests whether the databse supports savepoints.
- *
- * @return <code>true</code> if the database supports savepoints,
- * <code>false</code> if it does not.
- * @exception SQLException If an error occurs.
- * @see Savepoint
- * @since 1.4
- */
- boolean supportsSavepoints() throws SQLException;
- /**
- * This method tests whether the database supports named parameters.
- *
- * @return <code>true</code> if the database supports named parameters,
- * <code>false</code> if it does not.
- * @exception SQLException If an error occurs.
- * @since 1.4
- */
- boolean supportsNamedParameters() throws SQLException;
- /**
- * This method tests whether the database supports returning multiple
- * <code>ResultSet</code>S from a <code>CallableStatement</code> at once.
- *
- * @return <code>true</code> if the database supports returnig multiple
- * results at once, <code>false</code> if it does not.
- * @exception SQLException If an error occurs.
- * @since 1.4
- */
- boolean supportsMultipleOpenResults() throws SQLException;
- /**
- * @since 1.4
- */
- boolean supportsGetGeneratedKeys() throws SQLException;
- /**
- * @since 1.4
- */
- ResultSet getSuperTypes(String catalog, String schemaPattern,
- String typePattern) throws SQLException;
- /**
- * @since 1.4
- */
- ResultSet getSuperTables(String catalog, String schemaPattern,
- String tablePattern) throws SQLException;
- /**
- * @since 1.4
- */
- ResultSet getAttributes(String catalog, String schemaPattern, String
- typePattern, String attributePattern) throws SQLException;
- /**
- * This method tests if the database supports the specified holdability type.
- * Valid values for this parameter are specified in the
- * <code>ResultSet</code> class.
- *
- * @param holdability The holdability type to test.
- * @return <code>true</code> if the database supports the holdability type,
- * <code>false</code> if it does not.
- * @exception SQLException If an error occurs.
- * @see ResultSet
- * @since 1.4
- */
- boolean supportsResultSetHoldability(int holdability)
- throws SQLException;
- /**
- * This method returns the default holdability type of <code>ResultSet</code>S
- * retrieved from this database. The possible values are specified in the
- * <code>ResultSet</code> class.
- *
- * @return The default holdability type.
- * @exception SQLException If an error occurs.
- * @since 1.4
- */
- int getResultSetHoldability() throws SQLException;
- /**
- * This method returns the major version number of the database.
- *
- * @return The major version number of the database.
- * @exception SQLException If an error occurs.
- * @since 1.4
- */
- int getDatabaseMajorVersion() throws SQLException;
- /**
- * This method returns the minor version number of the database.
- *
- * @return The minor version number of the database.
- * @exception SQLException If an error occurs.
- * @since 1.4
- */
- int getDatabaseMinorVersion() throws SQLException;
- /**
- * This method returns the major version number of the JDBC driver.
- *
- * @return The major version number of the JDBC driver.
- * @exception SQLException If an error occurs.
- * @since 1.4
- */
- int getJDBCMajorVersion() throws SQLException;
- /**
- * This method returns the minor version number of the JDBC driver.
- *
- * @return The minor version number of the database.
- * @exception SQLException If an error occurs.
- * @since 1.4
- */
- int getJDBCMinorVersion() throws SQLException;
- /**
- * @since 1.4
- */
- int getSQLStateType() throws SQLException;
- /**
- * @since 1.4
- */
- boolean locatorsUpdateCopy() throws SQLException;
- /**
- * @since 1.4
- */
- boolean supportsStatementPooling() throws SQLException;
- }
|