// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

#if !defined(__D32DBMS_H__)

#define __D32DBMS_H__

#ifndef __S32STD_H__

#include <s32std.h>

#endif

#ifndef __F32FILE_H__

#include <f32file.h>

#endif

#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS 

	#include <d32dbmsconstants.h>

#endif

// other classes referenced

class RFs;

class CDbObject;

class CDbRowConstraint;

class CDbCursor;

class CDbDatabase;

class CDbIncremental;

class CDbNotifier;

class TDbColumn;

class TDbColumnC;

// classes defined

class TDbCol;

class CDbColSet;

class TDbColSetIter;

class TDbKeyCol;

class CDbKey;

class TDbBookmark;

class TDbQuery;

class RDbHandleBase;

template<class T> class RDbHandle;

class RDbRowConstraint;

class RDbRowSet;

class RDbColReadStream;

class RDbColWriteStream;

class TDbWindow;

class RDbView;

template<class T> class TUnion;

class TDbLookupKey;

class TDbSeekKey;

template<TInt S> class TDbSeekMultiKey;

class RDbTable;

class CDbNames;

class RDbDatabase;

class RDbIncremental;

class RDbUpdate;

class RDbNotifier;

class RDbs;

class RDbNamedDatabase;

class RDbStoreDatabase;

/**

The maximum length for a DBMS name: 64 characters.

@publishedAll

@released

*/

const TInt KDbMaxName=0x40;

/**

The maximum length for a DBMS column name: 64 characters.

@publishedAll

@released

*/

const TInt KDbMaxColName=KDbMaxName;

/** 

Represents a writable DBMS name. It maps to a modifiable buffer descriptor 

with maximum size KDbMaxName.

Notes:

A DBMS name must begin with an alphabetic character, after which any alphabetic, 

numeric or the _ (underscore) character may be used. DBMS names are also limited 

to 64 characters in length.

Table names must be unique within a database, and columns and indexes must 

have unique names within the table to which they belong. For the purposes 

of uniqueness and identification, the names are folded before comparison, 

so two columns named column_one and Column_ONE are considered to have the 

same name.

@see TBuf 

@publishedAll

@released

*/

typedef TBuf<KDbMaxName> TDbName;

/** Represents a non-writeable DBMS name. It maps to a non modifiable buffer descriptor 

with maximum size KDbMaxName.

Notes:

A DBMS name must begin with an alphabetic character, after which any alphabetic, 

numeric or the _ (underscore) character may be used. DBMS names are also limited 

to 64 characters in length.

Table names must be unique within a database, and columns and indexes must 

have unique names within the table to which they belong. For the purposes 

of uniqueness and identification, the names are folded before comparison, 

so two columns named column_one and Column_ONE are considered to have the 

same name.

@see TBufC 

@publishedAll

@released

*/

typedef TBufC<KDbMaxName> TDbNameC;

/** Represents a writable DBMS column name. It maps to a modifiable buffer descriptor 

with maximum size KDbMaxColName.

Notes:

A DBMS name must begin with an alphabetic character, after which any alphabetic, 

numeric or the _ (underscore) character may be used. DBMS names are also limited 

to 64 characters in length.

Table names must be unique within a database, and columns and indexes must 

have unique names within the table to which they belong. For the purposes 

of uniqueness and identification, the names are folded before comparison, 

so two columns named column_one and Column_ONE are considered to have the 

same name. 

@publishedAll

@released

*/

typedef TBuf<KDbMaxColName> TDbColName;

/** Represents a non-writable DBMS column name. It maps to a non-modifiable buffer 

descriptor with maximum size KDbMaxColName.

Notes:

A DBMS name must begin with an alphabetic character, after which any alphabetic, 

numeric or the _ (underscore) character may be used. DBMS names are also limited 

to 64 characters in length.

Table names must be unique within a database, and columns and indexes must 

have unique names within the table to which they belong. For the purposes 

of uniqueness and identification, the names are folded before comparison, 

so two columns named column_one and Column_ONE are considered to have the 

same name.

@see TBufC 

@publishedAll

@released

*/

typedef TBufC<KDbMaxColName> TDbColNameC;

/** Specifies when DBMS objects require a column ordinal to identify a column in 

a column set or in a rowset.

Note that KDbNullColNo is a special value of TDbColNo used to indicate that 

no such column exists. 

@publishedAll

@released

*/

typedef TInt TDbColNo;

/** 

Indicates that a specified column does not exist. 

@publishedAll

@released

*/

const TDbColNo KDbNullColNo=0;

/** 

A value returned by RDbRowSet::Count() when the number of rows cannot be determined.

@see RDbRowSet 

@publishedAll

@released

*/

const TInt KDbUndefinedCount=-1;

/** 

The length of a column is undefined. 

@publishedAll

@released

*/

const TInt KDbUndefinedLength=-1;

/** 

The default text column length. This is equal to 50. 

@publishedAll

@released

*/

const TInt KDbDefaultTextColLength=50;

/** 

Represents every supported column type. 

@publishedAll

@released

*/

enum TDbColType

	{

	/** The column stores a single bit.

	Representation range: 0 to 1

	Storage: 1 bit

	Auto-increment: Yes

	Index key: Yes */

	EDbColBit,

	/** The column stores an 8-bit signed integer.

	Representation range: -2^7 to 2^7 - 1

	Storage: 1 byte

	Auto-increment: Yes

	Index key: Yes */

	EDbColInt8,

	/** The column stores an 8-bit unsigned integer.

	Representation range: 0 to 2^8-1

	Storage: 1 byte

	Auto-increment: Yes

	Index key: Yes */

	EDbColUint8,

	/** The column stores a 16-bit signed integer.

	Representation range: -2^15 to 2^15 - 1

	Storage: 2 bytes

	Auto-increment: Yes

	Index key: Yes */

	EDbColInt16,

	/** The column stores a 16-bit unsigned integer.

	Representation range: 0 to 2^16-1

	Storage: 2 bytes

	Auto-increment: Yes

	Index key: Yes */

	EDbColUint16,

	/** The column stores a 32-bit signed integer.

	Representation range: -2^31 to 2^31 - 1

	Storage: 4 bytes

	Auto-increment: Yes

	Index key: Yes */

	EDbColInt32,

	/** The column stores a 32-bit unsigned integer.

	Representation range: 0 to 2^32-1

	Storage: 4 bytes

	Auto-increment: Yes

	Index key: Yes */

	EDbColUint32,

	/** The column stores a 64-bit signed integer.

	Representation range: -2^63 to 2^63 - 1

	Storage: 8 bytes

	Auto-increment: No

	Index key: Yes */

	EDbColInt64,

	/** The column stores a 32-bit floating point value.

	Representation range: 1.4 X 10^-45 to 3.40282 X 10^38

	Storage: 4 bytes

	Auto-increment: No

	Index key: Yes */

	EDbColReal32,

	/** The column stores a 64-bit floating point value.

	Representation range: 2.2 X 10^-308 to 1.79769 X 10^308

	Storage: 8 bytes

	Auto-increment: No

	Index key: Yes */

	EDbColReal64,

	/** The column stores a date/time value.

	Representation range: 1/1/0 to 31/12/9999

	Storage: 8 bytes

	Auto-increment: No

	Index key: Yes */

	EDbColDateTime,

	/** The column stores a (short) variable length of non-Unicode text data.

	Representation range: 0 to 256 characters

	Storage: 0 to 256 bytes

	Auto-increment: No

	Index key: Yes */

	EDbColText8,

	/** The column stores a (short) variable length of Unicode text data.

	Representation range: 0 to 256 characters

	Storage: 0 to 512 bytes

	Auto-increment: No

	Index key: Yes */

	EDbColText16,

	/** The column stores a (short) variable length of untyped data.

	Representation range: 0 to 255 bytes

	Storage: 0 to 256 bytes

	Auto-increment: No

	Index key: No */

	EDbColBinary,

	/** The column stores a potentially large amount of non-Unicode text data.

	Representation range: 0 to 2^31 characters

	Storage: 0 to 2 Gbytes

	Auto-increment: No

	Index key: Truncated */

	EDbColLongText8,

	/** The column stores a potentially large amount of Unicode text data.

	Representation range: 0 to 2^30 characters

	Storage: 0 to 2 Gbytes

	Auto-increment: No

	Index key: Truncated */

	EDbColLongText16,

	/** The column stores a potentially large amount of untyped data.

	Representation range: 0 to 2^31 bytes

	Storage: 0 to 2 Gbytes

	Auto-increment: No

	Index key: No */

	EDbColLongBinary,

	/** This is equivalent to EDbColText8 if the build is narrow, and 

	EDbColText16 if the build is Unicode. */

	EDbColText=EDbColText16,

	/** This is equivalent to EDbColLongText8 if the build is narrow, and 

	EDbColLongText16 if the build is Unicode. */

	EDbColLongText=EDbColLongText16

	};

/** 

Represents different ways of comparing Text and LongText columns.

This affects the ordering of indexes (see CDbKey), the evaluation of SQL 

queries and matching row constraints (see TDbQuery). 

@publishedAll

@released

*/

enum TDbTextComparison 

	{

	/** Use standard text comparison and ordering. */

	EDbCompareNormal,

	/** Use folded text for comparison and ordering. */

	EDbCompareFolded,

	/** Use collation for comparison and ordering. */

	EDbCompareCollated

	};

/** 

Defines a column in a table or rowset. 

The data members are public because this is really a structure to group the 

attributes of the column together. 

Three non-default constructors are provided for convenience. 

@publishedAll

@released

*/

class TDbCol

	{

	friend class CDbColSet;

public:

	enum {ENotNull=0x01,EAutoIncrement=0x02};

public:

	/** Constructs an uninitialised TDbCol. It is necessary because there are 

	also non-default constructors in this class. */

	inline TDbCol() {}

	inline TDbCol(const TDbCol&);

	inline TDbCol& operator=(const TDbCol&);

	IMPORT_C TDbCol(const TDesC& aName,TDbColType aType);

	IMPORT_C TDbCol(const TDesC& aName,TDbColType aType,TInt aMaxLength);

	static inline TBool IsLong(TDbColType aType);

private:

	inline TDbCol(const TDesC& aName);

public:

	/** The column type. */

	TDbColType iType;

	/** The maximum length of data that can be stored in a Text or Binary 

	column. */

	TInt iMaxLength;

	/** A set of flags describing other column attributes. This must be one 

	of the anonymous enum values ENotNull or EAutoIncrement. */

	TUint iAttributes;

	/** The column name. */

	TDbColNameC iName;

	};

/** Manages a set of column definitions which describe a table or rowset 

structure. Column definitions can be added and removed. The set can be 

iterated over, and ordinals for a column can be looked up.

The class is not intended for user derivation. 

@publishedAll

@released

*/

class CDbColSet : public CBase

	{

	friend class TDbColSetIter;

public:

	IMPORT_C CDbColSet();

	IMPORT_C static CDbColSet* NewL();

	IMPORT_C static CDbColSet* NewLC();

	IMPORT_C ~CDbColSet();

	inline const TDbCol& operator[](TDbColNo aCol) const;

	IMPORT_C const TDbCol* Col(const TDesC& aColName) const;

	IMPORT_C TDbColNo ColNo(const TDesC& aColName) const;

	inline TInt Count() const;

	inline void Clear();

	IMPORT_C CDbColSet& AddL(const TDbCol& aCol);

	IMPORT_C void Remove(const TDesC& aColName);

private:

	CArrayPakFlat<TDbCol> iColumns;

	};

/** 

Provides a useful way to iterate over the contents of a column set. 

@publishedAll

@released

*/

class TDbColSetIter

	{

public:

	IMPORT_C TDbColSetIter(const CDbColSet& aColSet);

	inline operator TAny* () const;

	inline const TDbCol& operator*() const;

	inline const TDbCol* operator->() const;

	IMPORT_C TDbColSetIter& operator++();

	inline TDbColSetIter operator++(TInt);

	inline TDbColNo Col() const;

private:

	const TDbCol* iColumn;

	TInt iIndex;

	const CArrayPakFlat<TDbCol>* iArray;

	};

/** Defines a key column in an index.

The data members are public as this is really a structure to group the 

attributes of the key column together. Two non-default constructors are 

provided for convenience. 

@publishedAll

@released

*/

class TDbKeyCol

	{

public:

	/** Specifies whether a key column in an index should be sorted in 

	ascending or descending order. */