Stay organized with collections
Save and categorize content based on your preferences.
RowId
public
interface
RowId
The representation (mapping) in the Java programming language of an SQL ROWID
value. An SQL ROWID is a built-in type, a value of which can be thought of as
an address for its identified row in a database table. Whether that address
is logical or, in any respects, physical is determined by its originating data
source.
Methods in the interfaces ResultSet, CallableStatement,
and PreparedStatement, such as getRowId and setRowId
allow a programmer to access a SQL ROWID value. The RowId
interface provides a method
for representing the value of the ROWID as a byte array or as a
String.
The method getRowIdLifetime in the interface DatabaseMetaData,
can be used
to determine if a RowId object remains valid for the duration of the transaction in
which the RowId was created, the duration of the session in which
the RowId was created,
or, effectively, for as long as its identified row is not deleted. In addition
to specifying the duration of its valid lifetime outside its originating data
source, getRowIdLifetime specifies the duration of a ROWID
value's valid lifetime
within its originating data source. In this, it differs from a large object,
because there is no limit on the valid lifetime of a large object within its
originating data source.
All methods on the RowId interface must be fully implemented if the
JDBC driver supports the data type.
Summary
Public methods |
|---|
abstract
boolean
|
equals(Object obj)
Compares this RowId to the specified object.
|
abstract
byte[]
|
getBytes()
Returns an array of bytes representing the value of the SQL ROWID
designated by this java.sql.RowId object.
|
abstract
int
|
hashCode()
Returns a hash code value of this RowId object.
|
abstract
String
|
toString()
Returns a String representing the value of the SQL ROWID designated by this
java.sql.RowId object.
|
Public methods
equals
public abstract boolean equals (Object obj)
Compares this RowId to the specified object. The result is
true if and only if the argument is not null and is a RowId
object that represents the same ROWID as this object.
It is important
to consider both the origin and the valid lifetime of a RowId
when comparing it to another RowId. If both are valid, and
both are from the same table on the same data source, then if they are equal
they identify
the same row; if one or more is no longer guaranteed to be valid, or if
they originate from different data sources, or different tables on the
same data source, they may be equal but still
not identify the same row.
| Parameters |
|---|
obj |
Object: the Object to compare this RowId object
against. |
| Returns |
|---|
boolean |
true if the RowIds are equal; false otherwise |
getBytes
public abstract byte[] getBytes ()
Returns an array of bytes representing the value of the SQL ROWID
designated by this java.sql.RowId object.
| Returns |
|---|
byte[] |
an array of bytes, whose length is determined by the driver supplying
the connection, representing the value of the ROWID designated by this
java.sql.RowId object. |
hashCode
public abstract int hashCode ()
Returns a hash code value of this RowId object.
| Returns |
|---|
int |
a hash code for the RowId |
toString
public abstract String toString ()
Returns a String representing the value of the SQL ROWID designated by this
java.sql.RowId object.
Like java.sql.Date.toString()
returns the contents of its DATE as the String "2004-03-17"
rather than as DATE literal in SQL (which would have been the String
DATE "2004-03-17"), toString()
returns the contents of its ROWID in a form specific to the driver supplying
the connection, and possibly not as a ROWID literal.
| Returns |
|---|
String |
a String whose format is determined by the driver supplying the
connection, representing the value of the ROWID designated
by this java.sql.RowId object. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# RowId\n\nAdded in [API level 9](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\nRowId\n=====\n\n\n`\npublic\n\n\ninterface\nRowId\n`\n\n\n`\n\n\n`\n\n|----------------|\n| java.sql.RowId |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nThe representation (mapping) in the Java programming language of an SQL ROWID\nvalue. An SQL ROWID is a built-in type, a value of which can be thought of as\nan address for its identified row in a database table. Whether that address\nis logical or, in any respects, physical is determined by its originating data\nsource.\n\n\nMethods in the interfaces `ResultSet`, `CallableStatement`,\nand `PreparedStatement`, such as `getRowId` and `setRowId`\nallow a programmer to access a SQL `ROWID` value. The `RowId`\ninterface provides a method\nfor representing the value of the `ROWID` as a byte array or as a\n`String`.\n\n\nThe method `getRowIdLifetime` in the interface `DatabaseMetaData`,\ncan be used\nto determine if a `RowId` object remains valid for the duration of the transaction in\nwhich the `RowId` was created, the duration of the session in which\nthe `RowId` was created,\nor, effectively, for as long as its identified row is not deleted. In addition\nto specifying the duration of its valid lifetime outside its originating data\nsource, `getRowIdLifetime` specifies the duration of a `ROWID`\nvalue's valid lifetime\nwithin its originating data source. In this, it differs from a large object,\nbecause there is no limit on the valid lifetime of a large object within its\noriginating data source.\n\n\nAll methods on the `RowId` interface must be fully implemented if the\nJDBC driver supports the data type. \n**See also:**\n\n- [DatabaseMetaData](/reference/java/sql/DatabaseMetaData)\n\nSummary\n-------\n\n| ### Public methods ||\n|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract boolean` | ` `[equals](/reference/java/sql/RowId#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Compares this `RowId` to the specified object. |\n| ` abstract byte[]` | ` `[getBytes](/reference/java/sql/RowId#getBytes())`() ` Returns an array of bytes representing the value of the SQL `ROWID` designated by this `java.sql.RowId` object. |\n| ` abstract int` | ` `[hashCode](/reference/java/sql/RowId#hashCode())`() ` Returns a hash code value of this `RowId` object. |\n| ` abstract `[String](/reference/java/lang/String) | ` `[toString](/reference/java/sql/RowId#toString())`() ` Returns a String representing the value of the SQL ROWID designated by this `java.sql.RowId` object. |\n\nPublic methods\n--------------\n\n### equals\n\nAdded in [API level 9](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract boolean equals (Object obj)\n```\n\nCompares this `RowId` to the specified object. The result is\n`true` if and only if the argument is not null and is a RowId\nobject that represents the same ROWID as this object.\n\n\nIt is important\nto consider both the origin and the valid lifetime of a `RowId`\nwhen comparing it to another `RowId`. If both are valid, and\nboth are from the same table on the same data source, then if they are equal\nthey identify\nthe same row; if one or more is no longer guaranteed to be valid, or if\nthey originate from different data sources, or different tables on the\nsame data source, they may be equal but still\nnot identify the same row.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------|-----------------------------------------------------------------------|\n| `obj` | `Object`: the `Object` to compare this `RowId` object against. \u003cbr /\u003e |\n\n| Returns ||\n|-----------|--------------------------------------------------------|\n| `boolean` | true if the `RowId`s are equal; false otherwise \u003cbr /\u003e |\n\n### getBytes\n\nAdded in [API level 9](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract byte[] getBytes ()\n```\n\nReturns an array of bytes representing the value of the SQL `ROWID`\ndesignated by this `java.sql.RowId` object.\n\n\u003cbr /\u003e\n\n| Returns ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `byte[]` | an array of bytes, whose length is determined by the driver supplying the connection, representing the value of the ROWID designated by this java.sql.RowId object. \u003cbr /\u003e |\n\n### hashCode\n\nAdded in [API level 9](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract int hashCode ()\n```\n\nReturns a hash code value of this `RowId` object.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|------------------------------------|\n| `int` | a hash code for the `RowId` \u003cbr /\u003e |\n\n### toString\n\nAdded in [API level 9](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract String toString ()\n```\n\nReturns a String representing the value of the SQL ROWID designated by this\n`java.sql.RowId` object.\n\n\nLike `java.sql.Date.toString()`\nreturns the contents of its DATE as the `String` \"2004-03-17\"\nrather than as DATE literal in SQL (which would have been the `String`\nDATE \"2004-03-17\"), toString()\nreturns the contents of its ROWID in a form specific to the driver supplying\nthe connection, and possibly not as a `ROWID` literal.\n\n\u003cbr /\u003e\n\n| Returns ||\n|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/String) | a String whose format is determined by the driver supplying the connection, representing the value of the `ROWID` designated by this `java.sql.RowId` object. \u003cbr /\u003e |"]]
