Inheritance diagram for Deveel.Data.Protocol.LocalQueryResult:

Public Member Functions
	LocalQueryResult (DeveelDbConnection connection)

int	FindColumnIndex (string name)
	Searches for the index of the column with the given name. More...

object	GetRuntimeValue (int ordinal)

ISqlObject	GetRawColumn (int column)

void	Setup (int id, QueryResultColumn[] columnList, int totalRowCount)

void	SetFetchSize (int rows)

void	SetMaxRowCount (int rowCount)

void	DownloadAndClose ()

void	Download (int rowIndex, int rowCount)

QueryResultColumn	GetColumn (int offset)

bool	First ()

bool	Next ()

void	Close ()

void	Dispose ()

Properties
bool	VerboseColumnNames `[get]`

int	MaxFetchSize `[get, private set]`

int	DefaultFetchSize `[get, private set]`

bool	Closed `[get, private set]`

int	QueryTime `[get, set]`

int	ResultId `[get, private set]`
	Returns the identificator that is used as a key to refer to the result set on the server that is the result of the command. More...

int	RowCount `[get]`
	The total number of rows in the result set. More...

int	ColumnCount `[get]`
	The column count of columns in the result set. More...

bool	HasLargeObject `[get]`

bool	IsUpdate `[get]`
	Returns true if this result set contains 1 column and 1 row and the name of the column is `result`. More...

int	AffectedRows `[get]`

Private Member Functions
	~LocalQueryResult ()

void	EnsureIndexLoaded ()
	Ensures that the row index pointed to by 'real_index' is actually loaded into the 'result_block'. More...

void	RealIndexUpdate ()

void	Dispose (bool disposing)

Private Attributes
DeveelDbConnection	connection

QueryResultColumn[]	columns

int	resultRowCount

int	maxRowCount = Int32.MaxValue

int	blockTopRow

int	blockRowCount

int	fetchSize

Dictionary< string, int >	columnHash

int	realIndex = Int32.MaxValue

int	realIndexOffset = -1

QueryResultPart	resultBlock

Detailed Description

Definition at line 25 of file LocalQueryResult.cs.

Constructor & Destructor Documentation

Deveel.Data.Protocol.LocalQueryResult.LocalQueryResult ( DeveelDbConnection connection )

inline

Definition at line 48 of file LocalQueryResult.cs.

                                                                {
             this.connection = connection;
 
             MaxFetchSize = connection.Settings.MaxFetchSize;
             DefaultFetchSize = connection.Settings.FetchSize;
         }

Deveel.Data.Protocol.LocalQueryResult.~LocalQueryResult ( )

inlineprivate

Definition at line 55 of file LocalQueryResult.cs.

                             {
             Dispose(false);
         }

Member Function Documentation

void Deveel.Data.Protocol.LocalQueryResult.Close ( )

inline

Definition at line 349 of file LocalQueryResult.cs.

                             {
             if (ResultId != -1) {
                 if (!Closed) {
                     // Request to close the current result set
                     connection.DisposeResult(ResultId);
                     Closed = true;
                 }
 
                 ResultId = -1;
                 realIndex = Int32.MaxValue;
 
                 // Clear the column name -> index mapping,
                 if (columnHash != null) {
                     columnHash.Clear();
                 }
             }
         }

void Deveel.Data.Protocol.LocalQueryResult.Dispose ( )

inline

Definition at line 367 of file LocalQueryResult.cs.

                               {
             Dispose(true);
             GC.SuppressFinalize(this);
         }

void Deveel.Data.Protocol.LocalQueryResult.Dispose ( bool disposing )

inlineprivate

Definition at line 372 of file LocalQueryResult.cs.

                                              {
             if (disposing) {
                 try {
                     Close();
                 } catch (DeveelDbException) {
                     // Ignore
                     // We ignore exceptions because handling cases where the server
                     // connection has broken for many ResultSets would be annoying.
                 }
             }
 
             connection = null;
             columns = null;
             resultBlock = null;
         }

void Deveel.Data.Protocol.LocalQueryResult.Download	(	int	rowIndex,
		int	rowCount
	)

inline

Definition at line 283 of file LocalQueryResult.cs.

                                                          {
             // If row_count is 0 then we don't need to do anything.
             if (rowCount == 0)
                 return;
 
             if (rowIndex + rowCount < 0)
                 throw new DeveelDbException("Result row index is before the start of the set.");
 
             if (rowIndex < 0) {
                 rowIndex = 0;
                 rowCount = rowCount + rowIndex;
             }
 
             if (rowIndex >= RowCount)
                 throw new DeveelDbException("Result row index is after the end of the set.");
             if (rowIndex + rowCount > RowCount)
                 rowCount = RowCount - rowIndex;
 
             if (ResultId == -1)
                 throw new DeveelDbException("Result ID is invalid.");
 
             try {
 
                 // Request the result via the RowCache.  If the information is not found
                 // in the row cache then the request is forwarded onto the database.
                 resultBlock = connection.RowCache.GetResultPart(ResultId, rowIndex, rowCount, ColumnCount, RowCount);
 
                 // Set the row that's at the top
                 blockTopRow = rowIndex;
 
                 // Set the number of rows in the block.
                 blockRowCount = rowCount;
             } catch(DeveelDbException) {
                 throw;
             } catch (Exception ex) {
                 throw new DeveelDbException("Error while downloading the result data.", ex);
             }
         }

void Deveel.Data.Protocol.LocalQueryResult.DownloadAndClose ( )

inline

Definition at line 277 of file LocalQueryResult.cs.

                                        {
             Download(0, resultRowCount);
             connection.DisposeResult(ResultId);
             Closed = true;
         }

void Deveel.Data.Protocol.LocalQueryResult.EnsureIndexLoaded ( )

inlineprivate

Ensures that the row index pointed to by 'real_index' is actually loaded into the 'result_block'.

If not, we send a request to the database to get it.

Definition at line 136 of file LocalQueryResult.cs.

                                          {
             if (realIndex == -1)
                 throw new DeveelDbException("Row index out of bounds.");
 
             // Offset into our block
             int rowOffset = realIndex - blockTopRow;
             if (rowOffset >= blockRowCount) {
                 // Need to download the next block from the server.
                 Download(realIndex, fetchSize);
                 // Set up the index into the downloaded block.
                 rowOffset = realIndex - blockTopRow;
                 realIndexOffset = rowOffset;
             } else if (rowOffset < 0) {
                 int fsDif = System.Math.Min(fetchSize, 8);
                 // Need to download the next block from the server.
                 Download(realIndex - fetchSize + fsDif, fetchSize);
                 // Set up the index into the downloaded block.
                 rowOffset = realIndex - blockTopRow;
                 realIndexOffset = rowOffset;
             }
         }

int Deveel.Data.Protocol.LocalQueryResult.FindColumnIndex ( string name )

inline

Searches for the index of the column with the given name.

Parameters

name

Returns: Returns a zero-based index representing the position of the column with the given name among those in the result.

Exceptions

DatabaseException If no column with the given name was found within the result.

Definition at line 169 of file LocalQueryResult.cs.

                                                 {
             // For speed, we keep column name -> column index mapping in the hashtable.
             // This makes column reference by string faster.
             if (columnHash == null) {
                 var comparer = connection.Settings.IgnoreIdentifiersCase ? StringComparer.OrdinalIgnoreCase : StringComparer.Ordinal;
                 columnHash = new Dictionary<string, int>(comparer);
             }
 
             int index;
             if (!columnHash.TryGetValue(name, out index)) {
                 int colCount = ColumnCount;
                 // First construct an unquoted list of all column names
                 String[] cols = new String[colCount];
                 for (int i = 0; i < colCount; ++i) {
                     String colName = columns[i].Name;
                     if (colName.StartsWith("\"")) {
                         colName = colName.Substring(1, colName.Length - 2);
                     }
                     // Strip any codes from the name
                     if (colName.StartsWith("@")) {
                         colName = colName.Substring(2);
                     }
 
                     cols[i] = colName;
                 }
 
                 for (int i = 0; i < colCount; ++i) {
                     String colName = cols[i];
                     if (colName.Equals(name)) {
                         columnHash[name] = i ;
                         return i;
                     }
                 }
 
                 // If not found then search for column name ending,
                 string pointName = "." + name;
                 for (int i = 0; i < colCount; ++i) {
                     String colName = cols[i];
                     if (colName.EndsWith(pointName)) {
                         columnHash[name] = i;
                         return i;
                     }
                 }
 
                 throw new DeveelDbException("Couldn't find column with name: " + name);
             }
             
             return index;
         }

bool Deveel.Data.Protocol.LocalQueryResult.First ( )

inline

Definition at line 332 of file LocalQueryResult.cs.

                             {
             realIndex = 0;
             RealIndexUpdate();
             return realIndex < RowCount;
         }

QueryResultColumn Deveel.Data.Protocol.LocalQueryResult.GetColumn ( int offset )

inline

Definition at line 322 of file LocalQueryResult.cs.

                                                        {
             return columns[offset];
         }

ISqlObject Deveel.Data.Protocol.LocalQueryResult.GetRawColumn ( int column )

inline

Definition at line 230 of file LocalQueryResult.cs.

                                                    {
             // ASSERTION -
             // Is the given column in bounds?
             if (column < 0 || column >= ColumnCount)
                 throw new IndexOutOfRangeException("Column index out of bounds: 1 > " + column + " > " + ColumnCount);
 
             // Ensure the current indexed row is fetched from the server.
             EnsureIndexLoaded();
 
             var row = resultBlock.GetRow(realIndexOffset);
             return row.Values[column];
         }

object Deveel.Data.Protocol.LocalQueryResult.GetRuntimeValue ( int ordinal )

inline

Definition at line 219 of file LocalQueryResult.cs.

                                                    {
             var value = GetRawColumn(ordinal);
 
             if (value == null || value.IsNull)
                 return DBNull.Value;
 
             var destType = GetColumn(ordinal).RuntimeType;
 
             return Convert.ChangeType(value, destType, CultureInfo.InvariantCulture);
         }

bool Deveel.Data.Protocol.LocalQueryResult.Next ( )

inline

Definition at line 338 of file LocalQueryResult.cs.

                            {
             int rowCount = RowCount;
             if (realIndex < rowCount) {
                 ++realIndex;
                 if (realIndex < rowCount) {
                     RealIndexUpdate();
                 }
             }
             return (realIndex < rowCount);
         }

void Deveel.Data.Protocol.LocalQueryResult.RealIndexUpdate ( )

inlineprivate

Definition at line 326 of file LocalQueryResult.cs.

                                        {
             // Set up the index into the downloaded block.
             int rowOffset = realIndex - blockTopRow;
             realIndexOffset = rowOffset;
         }

void Deveel.Data.Protocol.LocalQueryResult.SetFetchSize ( int rows )

inline

Definition at line 269 of file LocalQueryResult.cs.

                                            {
             fetchSize = rows > 0 ? System.Math.Min(rows, MaxFetchSize) : DefaultFetchSize;
         }

void Deveel.Data.Protocol.LocalQueryResult.SetMaxRowCount ( int rowCount )

inline

Definition at line 273 of file LocalQueryResult.cs.

                                                  {
             maxRowCount = rowCount == 0 ? Int32.MaxValue : rowCount;
         }

void Deveel.Data.Protocol.LocalQueryResult.Setup	(	int	id,
		QueryResultColumn[]	columnList,
		int	totalRowCount
	)

inline

Definition at line 257 of file LocalQueryResult.cs.

                                                                                      {
             ResultId = id;
             columns = columnList;
             resultRowCount = totalRowCount;
             blockTopRow = -1;
             resultBlock = null;
 
             realIndex = -1;
             fetchSize = connection.Settings.FetchSize;
             Closed = false;
         }

Member Data Documentation

int Deveel.Data.Protocol.LocalQueryResult.blockRowCount

private

Definition at line 38 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.blockTopRow

private

Definition at line 37 of file LocalQueryResult.cs.

Dictionary<string, int> Deveel.Data.Protocol.LocalQueryResult.columnHash

private

Definition at line 41 of file LocalQueryResult.cs.

QueryResultColumn [] Deveel.Data.Protocol.LocalQueryResult.columns

private

Definition at line 31 of file LocalQueryResult.cs.

DeveelDbConnection Deveel.Data.Protocol.LocalQueryResult.connection

private

Definition at line 26 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.fetchSize

private

Definition at line 39 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.maxRowCount = Int32.MaxValue

private

Definition at line 35 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.realIndex = Int32.MaxValue

private

Definition at line 43 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.realIndexOffset = -1

private

Definition at line 44 of file LocalQueryResult.cs.

QueryResultPart Deveel.Data.Protocol.LocalQueryResult.resultBlock

private

Definition at line 46 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.resultRowCount

private

Definition at line 33 of file LocalQueryResult.cs.

Property Documentation

int Deveel.Data.Protocol.LocalQueryResult.AffectedRows

get

Definition at line 243 of file LocalQueryResult.cs.

bool Deveel.Data.Protocol.LocalQueryResult.Closed

getprivate set

Definition at line 67 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.ColumnCount

get

The column count of columns in the result set.

Definition at line 96 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.DefaultFetchSize

getprivate set

Definition at line 65 of file LocalQueryResult.cs.

bool Deveel.Data.Protocol.LocalQueryResult.HasLargeObject

get

Definition at line 100 of file LocalQueryResult.cs.

bool Deveel.Data.Protocol.LocalQueryResult.IsUpdate

get

Returns true if this result set contains 1 column and 1 row and the name of the column is result.

This indicates the result set is a DDL command ( UPDATE, INSERT, CREATE, ALTER, etc ).

NOTE: This is a minor hack because there is no real indication that this is a DML statement. Theoretically a SQL command could be constructed that meets a ll these requirements and is processed incorrectly.

Definition at line 120 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.MaxFetchSize

getprivate set

Definition at line 63 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.QueryTime

getset

Definition at line 69 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.ResultId

getprivate set

Returns the identificator that is used as a key to refer to the result set on the server that is the result of the command.

An identificator of -1 means there is no server side result set associated with this object.

Definition at line 79 of file LocalQueryResult.cs.

int Deveel.Data.Protocol.LocalQueryResult.RowCount

get

The total number of rows in the result set.

Definition at line 84 of file LocalQueryResult.cs.

bool Deveel.Data.Protocol.LocalQueryResult.VerboseColumnNames

get

Definition at line 59 of file LocalQueryResult.cs.

The documentation for this class was generated from the following file:

/var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Client/LocalQueryResult.cs

Public Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation