/* $Header$ */

// Generic DAM Non-Visual Component Resources
// Copyright (C) OMNIS Software Inc 1999

/* Changes
08-Dec-25		gra1619a ST/*A/183	Added $escapefetch
11-Jul-24		gra1591						Added error message for CE,JP,1x & 2x serial numbers
06-Jan-21		caa2035	ST/*A/162	Tracking slow running queries
02-Mar-21		gra1313	ST/DC/814	Various updates for the code assistant/internal docs
23-Jun-20		graDML2 			MkII DML Emulator (supersedes gra1125x, gra1162, gra1170)
07-Feb-20		gra1212	ST/*P/066	Added $sessionObj.$maxresultsetsize
11-Jul-19		gra1191	ST/*A/136	Added sessionObj.$batchsize
07-Jun-19		rmm10118					Improved some property descriptions.
20-May-19		gra1182	ST/@A/071	Added $maxresultsetsize
09-Aug-17		rmm9446	ST/*L/030	Fixed crash calling $progress from $run().
29-May-15   gra1041 ST/*A/110 Added $debugsize
27-Nov-14		rmm8461	ST/PF/844	Added $completed and $cancelled to worker objects.
05-Aug-14   gra0990 ST/*P/051 Added $bytesreceived & $bytessent
11-Jun-14   gra0964           Added missing worker properties
13-May-14   gra0971 ST/*A/102 Added optional flags parameter to $columns
17-Dec-13		gra0947	ST/*L/010	Implemented $commitretries & $commitdelay
06-May-13		gra0884	ST/*A/092	Added $fetch64bitints
28-Sep-12		gra0846b					Added sessionref
17-Apr-12		gra0844						Worker object support
10-Feb-12		gra0841	ST/*B/092	Problem initialising $defaultdate when language not English
17-Aug-11		gra0806	ST/*O/131	Implemented quoted identifiers
02-Oct-09		gra0670	ST/*A/075 Added $codepage
19-May-09		gra0612	ST/*A/071	Added $unicode
30-Oct-08		gra0580	ST/*O/111	Restore batchsize each time statement is executed
14-May-08		gra0530	ST/*A/065	Implemented debugging
05-Dec-07		gra0491						Unicode character conversion changes
01-Feb-06		gra0346						damobj.rc must now be inlined into impl.
23-May-05		rmm5372	ST/*A/033	$newstatement and $newstatementref: statement name parameter is optional.
18-Apr-05		gra0256	UN/*A/049	$fetchtofile modified for unicode output
06-Jan-05		gra0235	ST/*A/043	Enable DAMs access to schema info
20-May-04		gra0210	ST/*A/038	Implement $fetchtofile
19-Apr-04		gra0204						Batch fetching
06-Aug-03		gra0148	ST/*A/033	Automatic statement name generation
15-Oct-02		rmm4282						Implemented $fetchinto.
16-Sep-02		rmmv4obj					Added support for pointer-style objects (object reference variables).
01-Jul-02		gra0090	ST/*A/020	Allow empty dates to be inserted as Nulls
14-Feb-01		crCARBON
14-Jul-00		cr1127						Change $stripspaces to $sqlstripspaces to match library property
13-Jul-00		cr1126						Added $begin
05-Jul-00		cr1122	ST/*A/007	Allow map file match with lower case .in/.out suffix
26-Jun-00		cr1114	ST/*B/008	Added $allowstransactions to prevent transaction commands being invoked
																when the connect does not support them
18-Jun-00		cr1110							Added $sqlseparators						
16-Jun-00		cr1109							Added $errortext
23-May-00		cr1092							Added $clear
05-May-00		rmm3741							Added DAM-specific information column to meta data result sets.
26-Apr-00		cr1071							Implement $damname, $version ,$apiversion						
25-Apr-00		cr1070							Tidied up defaultdate resource
25-Apr-00		cr1069							Implement $stripspaces
20-Apr-00		gra0005							$defaultdate implementation
10-Apr-00		cr1062							Do prepare & execute if direct execution is not supported by DAM
03-Apr-00		rmm3693							RPCs.
17-Mar-00		cr1034							Linux port
13-Mar-00		rmm3679							$sessions
09-Mar-00		cr1030							Character mapping
15-Feb-00		cr1018							Version, server specific, cursors
11-Feb-00		cr1015							Direct execution
01-Feb-00		cr1012							Error code generation
25-Jan-00		cr1005							Chunking
10-Jan-00		cr1001							Transactions
07-Jan-00		ijt005							Added statement generation calls
15-Dec-99		rmm3568							Added meta-data methods
17-Sep-99												Created cr
*/

		//gra0346 This file must be included inside the derived resource file	
		
			1001	"Worker Objects" //gra0844 

		// Note: resources 2000-5999 are reserved for use by the platform dependent DAM code

    	// Object Instance methods
    	6000	"$logon:$logon(cHostname,cUsername,cPassword[,cSessionName]) Connect session to server. Returns kTrue on success, kFalse otherwise"
			6001	"$logoff:$logoff() Drop connection to server. Returns kTrue on success, kFalse otherwise"
			6002	"$newstatement:$newstatement([cStatementname]) Creates and returns a new dynamic instance of a statement object for the session; typically used to return a new statement object to an object variable with no subtype specified" // rmm5372
			6003	"$coltext:$coltext(vVarRef) Returns a SQL text description of the vVarRef parameter for use in a SQL statement"//ijt005
			6004	"$selectnames:$selectnames(vTableDef[,cTableName]) Returns a text string defining the columns to be used in a SQL SELECT statement"//ijt005
			6005	"$insertnames:$insertnames(wRowRef) Returns a text string which is a comma delimited list specifiying the columns to be used in a SQL INSERT statement"//ijt005
			6006	"$updatenames:$updatenames(wRowRef) Returns a text string which is used as part of a SQL UPDATE statement"//ijt005
			6007	"$wherenames:$wherenames(wRowRef[,cTableName,cComparison,cOperator]) Returns a text string which is used as part of a SQL WHERE clause"//ijt005
			6008	"$createnames:$createnames(vTableDef[,bNullInfo,bPrimaryKeys]) Returns a text string defining the columns and types to be used as part of a SQL CREATE TABLE statement"//ijt005 //gra0235
			6009	"$commit:$commit() Commits session transaction. Returns kTrue on success, kFalse otherwise"																		//cr1001
			6010	"$rollback:$rollback() Rollback session transaction. Returns kTrue on success, kFalse otherwise"															//cr1001
			6011	"$nextnativeerror:$nextnativeerror() Retrieves the next $nativeerrorcode & $nativeerrortext. Returns kTrue on success, kFalse otherwise"					// cr1012
			6012	"$rpcdefine:$rpcdefine(cRpcName,lParamList) defines a remote procedure prior to calling $rpc(). lParamList is normally obtained from $rpcparameters(). Returns kTrue on success, kFalse otherwise"						// rmm3693
			6013	"$clear:$clear() Clear all statements. Returns kTrue on success, kFalse otherwise"																						// cr1092
			6014	"$begin:$begin() Begins a session transaction when $transactionmode is kSessionTranManual. Returns kTrue on success, kFalse otherwise"				// cr1126
			6015	"$newstatementref:$newstatementref([cStatementname]) Creates and returns a new dynamic instance of a statement object for the session,to be used with an Object reference variable;typically used to return a new statement to an object reference variable" // rmmv4obj // rmm5372
			6016	"$dmlexec:$dmlexec([vParam0]...) Reserved for use with DML emulator" //graDML2
			// Properties
			7000	"$hostname:Database name or alias used for connection. $hostname might be an IP-address or machine name. For ODBC, Oracle and Sybase it should be the name of a pre-defined DSN"
			7001	"$username:User name used to authenticate the connection"
			7002	"$password:Password used to authenticate connection"
			7003	"$state:The session state. A kSessionState... constant that indicates the current state of the session" // rmm10118
			7004	"$transactionmode:The transaction mode. A kSessionTran... constant that specifies the transaction mode for the session"	// cr1001 start // rmm10118
			7005	"$autobegintran:Indicates whether SQL transactions are automatically started on commit/rollback. Read-only"
			7006	"$commitmode:The session commit mode.  A kSessionCommit... constant that specifies what happens to prepared statements and cursors on commit" // rmm10118
			7007	"$rollbackmode:The session rollback mode.  A kSessionRollback... constant that specifies what happens to prepared statements and cursors on rollback"	// cr1001 end // rmm10118
			7008	"$lobthreshold:Threshold at which large character and binary data is chunked. Binary values of size <= $lobthreshold are fetched as a single chunk"			// cr1005
			7009	"$lobchunksize:The size of each chunk used to send large character and binary data (binary values larger in size than $lobthreshold)"		// cr1005
			7010	"$errorcode:Omnis internal error code generated by last session command"	// cr1012 start												
			7011	"$nativeerrorcode:Database-specific native error code generated by the last session command"
			7012	"$nativeerrortext:Database-specific native error text generated by the last session command"
			7013	"$nativeerrorpending:kTrue if further native errors are available for the session. Read-only" // cr1012 end
			7014	"$codepage:The code page used to interpret non-Unicode character data. A kUniType... constant that identifies an 8 bit character set (not kUniTypeUTF8)" //gra0670 // rmm10118
			7015	"$maptable:File name (minus the .in/.out extension) defining the 8-bit character mapping tables to be used with non-Unicode character data" // cr1030 
			7016	"$charmap:Denotes the character set used for mapping non-Unicode character data;  a kSessionCharMap... constant. Note: this property is deprecated and is superseded by $codepage" // cr1030 // rmm10118
			7017	"$blobsize:Default binary object size used by $createnames() and $coltext() when creating table columns from Omnis binary fields" // cr1034
			7018	"$defaultdate:Default date used for DateTime values. Used to substitute missing date parts into database columns where these would otherwise cause insertion errors" //gra0005
			7019	"$sqlstripspaces:Denotes whether character data fetched from the database has trailing spaces stripped" // cr1069, cr1127
			7020	"$damname:The name of the DAM object (read-only)" // cr1071 start
			7021	"$version:The version of the database that the session is connected to"
			7022	"$apiversion:The version of the client api that the DAM was built with"
			7023 	"$errortext:Omnis error text generated by last session command"	// cr1109
			7024	"$sqldecimalseparator:Decimal separator used by server. Omnis numbers are output using this deciaml point character (not the current $separators dpch character)"	// cr1110
			7025	"$sqlthousandseparator:Thousand separator used by server. (No longer used since most databases do not support/display a thousands separator)"	// cr1110
			7026	"$allowstransactions:kTrue if the DBMS supports manual transactions (read-only)" // cr1114
			7027	"$emptydateisnull:If kTrue, empty datetimes are treated as NULL values for INSERTs and UPDATEs. If kFalse, $defaultdate is used"
			7028	"$encoding:The Unicode encoding used by the database.  A kSessionEncoding... constant (read-only)"// cr1071 end // rmm10118
			7029	"$debugfile:If assigned, the DAM writes debug information to the specified file. Set $debuglevel to enable/disable logging" //gra0530
			7030	"$debuglevel:Specifies the level of debug information that will be written to $debugfile. Values 1-4 specify increasing amounts of debug information. Zero disables logging" //gra0530
			7031	"$unicode:If kTrue, Unicode data types/mappings are used with character data. If kFalse, the DAM reverts to ANSI behaviour and the DAM will attempt to map any Unicode characters to the specified $codepage" //gra0612
			7032	"$quotedidentifier:If kTrue, table instances and session methods will generate quoted column & table name identifiers, thus preserving mixed-case names and names" //gra0806
			7033	"$fetch64bitints:If kTrue, 64-bit integers are fetched into Omnis 64-bit Integer fields. If kFalse, they are fetched as 32-bit Integers and truncated accordingly" //gra0884
			7034	"$commitretries:The number of times a $commit() operation will retry before failing" //gra0947
			7035	"$commitdelay:The delay (in milliseconds) between each $commit() retry" //gra0947
			7036	"$bytesreceived:The number of bytes received through the session object since logon. Assigning to this property resets the value to zero" //gra0990
			7037	"$bytessent:The number of bytes sent through the session object since logon. Assigning to this property resets the value to zero" //gra0990
			7038 	"$debugsize:The maximum size of $debugfile generated before automatic truncation occurs. Assigning zero disables truncation" //gra1041
			7039	"$batchsize:The number of rows to retrieve simultaneously. Statement objects inherit this value. $batchsize is not supported by all databases in which case it reverts to 1" //gra1191
			7040	"$maxresultsetsize:The maximum size of a result set. Statement objects inherit this value. When a $fetch(kFetchAll) exceeds this value, the result set is trunacted and kFetchMemoryExceeded is returned" //gra1212
			7041	"$trackslowqueries:Queries running longer than the amount of seconds specified in this property will be reported as a slow running query to the trace log. Defaults to 0 (off)" // caa2035
			
			// Parameters
			8000	"Hostname:Database name, alias or IP-address where the database server is being hosted. (ODBC, DB2, Sybase and Oracle require a pre-defined DSN)"
			8001	"Username:User name used to authenticate the connection"
			8002	"Password:Password used to authenticate the connection"
			8003	"Statementname:Optional name used to identify the statement"
			8004	"VarRef:Omnis Column or Variable needed to determine SQL Text"//ijt005
			8005	"TableDef:List or Row Variable needed to determine SQL Text"//ijt005
			8006	"TableName:Optional Table name if qualified column names are required"//ijt005
			8007	"RowRef:Row Variable needed to determine SQL Text"//ijt005
			8008	"RowRef:Row Variable needed to determine SQL Text"//ijt005
			8009	"RowRef:Row Variable needed to determine SQL Text"//ijt005
			8010	"TableName:Optional table name if qualified column names are required"//ijt005
			8011	"Comparison:Use to specify a different comparison relation. The default is '='"//ijt005
			8012	"Operator:AND or OR keyword required in where clause. The default is 'AND'"//ijt005
			8013	"TableDef:List or Row Variable needed to determine SQL Text"//ijt005
			8014	"SessionName:Optional session name. If supplied, the session can be used via $sessions"	// rmm3679
			8015	"NullInfo:Optional flag. Set to kTrue if NULL/NOT NULL info should also be generated"//gra0235
			8016	"PrimaryKeyInfo:Optional flag. Set to kTrue if primary key info should also be generated"//gra0235

			// Statement Instance Methods
			9000	"$prepare:$prepare([cSQLtext]) Prepares the specified SQL text. If omitted $prepare() uses the current Begin/End statement SQL buffer. Returns kTrue on success, kFalse otherwise"
			9001	"$execute:$execute() Executes SQL text prepared previously usiung $prepare().  Returns kTrue on success, kFalse otherwise"
			9002	"$fetch:$fetch([lListOrRow][,iRowCount][,bAppend]) Fetches data into the supplied list or row. Returns a kFetch... constant, e.g. kFetchOk. See Catalog(F9)->Tables for other fetch states"
			9003	"$clear:$clear() Clears pending results or operations. Returns kTrue on success, kFalse otherwise"
			9004	"$fetchinto:$fetchinto(...) Fetches a row of data into the supplied variables,one column of result data per variable. Returns a kFetch... constant, e.g. kFetchOk. See Catalog(F9)->Tables for other fetch states" // rmm4282
			9005	"$fetchtofile:$fetchtofile(cFileName[,iRowCount][,bAppend][,bColumnNames][,iEncoding]) Fetches data into an external file. iEncoding is a kUniType... constant. Returns a kFetch... constant, e.g. kFetchOk. See Catalog(F9)->Tables for other fetch states" //gra0210 (gra0256)

			// rmm3568: Meta-data methods
			9100	"$tables:$tables([iTableType=kStatementServerAll][,cTableOwner]) Generates a result set listing the available tables. Returns kTrue on success, kFalse otherwise. Call $fetch() to retrieve the result set"
			9101	"$columns:$columns(cTableName) Generates a result set describing the columns of the specified table.  Returns kTrue on success, kFalse otherwise. Call $fetch() to retrieve the result set"
			9102	"$indexes:$indexes(cTableName[,iIndexType=kStatementIndexUnique]) Generates a result set providing information about the indexes of a specified table.  Returns kTrue on success, kFalse otherwise. Call $fetch() to retrieve the result set"
			9103	"$results:$results(lListOrRow) Populates the supplied with a description of the columns in the current result set. Returns kTrue on success, kFalse otherwise"
			9104, "$rpcprocedures:$rpcprocedures([cRpcOwner]) Generates a result set listing the available remote procedures. Returns kTrue on success, kFalse otherwise. Call $fetch() to retrieve the result set"														// rmm3693
			9105, "$rpcparameters:$rpcparameters(cRpcName) Generates a result set listing the parameters of the specified remote procedure(s). Returns kTrue on success, kFalse otherwise. Call $fetch() to retrieve the result set"	// rmm3693
			// cr1012: Error
			9110	"$nextnativeerror:$nextnativeerror() When $nativeerrorpending is kTrue, retrieves the next native statement error code & error text from the DBMS"
			// cr1015: Direct execution
			9111	"$execdirect:$execdirect([cSQLtext]) One time execution of the specied SQL text. If omitted $execdirect() uses the current Begin/End statement SQL buffer. Returns kTrue on success, kFalse otherwise"
			// rmm3693: RPC calls
			9120  "$rpc:$rpc(cRpcName[,vRpcParam1,...]) calls a remote procedure. The procedure must be previously defined using $rpcdefine(). Returns kTrue on success, kFalse otherwise"
			// Properties
			10000	"$statementname:Name of the statement object (read-only)"
			10001	"$sqltext:The currently assigned SQL text (read-only)"
			10002	"$resultspending:kTrue if a result set exists (read-only)"
			10003	"$state:The current state of statement object, one of the kStatementState... constants (read-only)"
			10004	"$rowsaffected:Rows affected by last executed INSERT or UPDATE statement. Some databases do not support this property in which case the value will be -1 (read-only)"
			10005	"$columncount:The number of columns in the current result set (read-only)"
			10006	"$rowcount:The number of rows in the current result set (read-only)"
			10007	"$rowsfetched:The number of rows retrieved by the last $fetch() (read-only)"
			// cr1012 start
			10008	"$errorcode:The Omnis error code generated by last statement command (read-only)"													
			10009	"$nativeerrorcode:The DBMS-specific native error code generated by last statement command (read-only)"
			10010 	"$nativeerrortext:The DBMS-specific native error text generated by last statement command (read-only)"
			10011	"$nativeerrorpending:kTrue if further native errors are available for the statement (read-only)"
			10012 "$rpcreturnvalue:Receives the return value of the most recent call to a remote procedure (read-only)"	// rmm3693
			// cr1012 end
			// cr1018
			10020 "$usecursor:Setting $usecursor to kTrue enables the use of a cursor for this statement (if the database supports cursors). $transactionmode should also be kSessionTranManual"
			// cr1069, cr1127
			10021 "$sqlstripspaces:If kTrue, trailing spaces stripped from any fetched character data"
			10022 "$errortext:The Omnis error text generated by last statement command (read-only)"	// cr1109
			10023 "$maxbuffersize:Sets the maximum buffer size per column- used when batch fetching. If a $fetch() exceeds this value; $effectivebatchsize receives the value that was used" //gra0204
			10024 "$batchsize:The number of rows to retrieve simultaneously- enables batch fetching. Some databases do not support batch fetching in which case the value reverts to 1" //gra0204
			10025 "$columndelimiter:The character which delimits column values when using $fetchtofile" //gra0210
			10026 "$rowdelimiter:The character which delimits row values when using $fetchtofile" //gra0210
			10027 "$effectivebatchsize:The revised batch size being used for the current statement. This differs from $batchsize in cases where $maxbuffersize is exceeded (read-only)" //gra0580
			10028 "$maxresultsetsize:The maximum size of a result set. $fetch() stops fetching rows when this limit is exceeded (and $fetch() returns kFetchMemoryExceeded)" //gra1182
			10029 "$escapefetch:If kTrue, a long running $fetch() can be escaped by pressing Ctrl-break/Ctrl-C/Cmd-period. Interim results are returned. Adversely affects performance on macOS." //gra1619a

			// Parameters
			11000	"SQLtext:Statement text to be used"
			11001	"ListOrRow:List or row for the returned data"
			11002	"RowCount:The number of rows to return"
			11003	"Append:Append to the list"
			11004 "TableType:The type of the tables to return in the result set, one of the kStatementServer... constants"
			11005 "TableOwner:The owner of the table(s)"
			11006 "TableName:The name of a table"
			11007 "IndexType:The type of the indexes to return in the result set, one of the kStatementIndex... constants"
			// Start rmm3693
			11008,"RpcName:The name of the remote procedure"
			11009,"Flags:Flags that modify the behaviour of this method" //gra0971
			11011,"ParamList:A list of remote procedure parameters"
			11012,"RpcParam1...:A parameter to pass to a remote procedure"
			11013,"RpcOwner:The owner of the remote procedure"
			// End rmm3693
			//gra0210 start
			11014 "Filename:Full path of the destination file"
			11015 "Append:Append data to an existing file"
			11016 "ColumnNames:Insert column names in the first row"
			11017 "Encoding:The unicode encoding to be used, one of the kUniType... constants" //gra0256
			//gra0210 end
			// Column names for meta-data result sets
			12000 "Owner"
			12001 "TableOrViewName"
			12002 "TableType"
			12003 "Description"
			12004 "DatabaseOrCatalog"
			12005 "ColumnName"
			12006 "OmnisDataTypeText"
			12007 "SQLDataType"
			12008 "Length"
			12009 "Scale"
			12010 "Null"
			12011 "Index"
			12012 "PrimaryKey"
			12013 "IndexName"
			12014 "Unique"
			12015 "ColumnPosition"
			12016 "OmnisDataType"
			12017 "OmnisDataSubType"
			12018,"ProcedureName"	// rmm3693
			12019,"ParameterName"	// rmm3693
			12020,"PassType"			// rmm3693
			12021,""							// rmm3693: for reserved list columns
			12022,"DamInfoRow"		// rmm3741
			// Map table suffix strings
			12025 ".out"					// cr1122
			12026 ".in"						// cr1122
			//Miscellaneous
			12029 "Community Edition serial number does not permit the use of this DAM" //gra1591
			//gra0841 12030	"01 Jan 2000 00:00:00"	//Default-defaultdate gra0005, cr1070
			12031 "$clib.$prefs.$sqlstripspaces" // cr1069 : calculation to retrieve library stripspaces preference
			12032 "$root.$prefs.$separators"				// cr1110 start
			12033 "."	// default decimal separator
			12034 ","	// default thousand separator	// cr1110 end
			12035 "sys(115)"	// crCARBON
			12036 "statement_"	//gra0148

			//DAM Statement worker methods //gra0844
			14000 "$init:Initialise statement worker object. Returns kTrue on success, kFalse otherwise"
			14001 "$run:Run statement worker on main thread. Returns kTrue on success, kFalse otherwise"
			14002 "$start:Run statement worker on background thread. Returns kTrue on success, kFalse otherwise"
			14003 "$cancel:Cancel statement on background thread. Returns kTrue on success, kFalse otherwise"
			14004 "$sessionref:Returns an object reference to the worker's internal session object" //gra0846b
			14005 "$completed:$completed(wResults) Method called when the request completes. wResults is a row containing the results of executing the request" // rmm8461
			14006 "$cancelled:$cancelled() Method called when the request has been cancelled" // rmm8461
			14007 "$progress:$progress(wProgress) Method called during worker execution to report progress" // rmm9446

			//DAM Statement worker properties //gra0844
			14030 "$state:Returns the current state of the worker object"
			14031 "$errortext:Error text associated with the last action"
			14032 "$cancelifrunning:If kTrue, the worker object sends a cancel request to the delegate object upon object re-use/destruction"
			14033 "$threadcount:Returns the number of active background threads for all worker instances"
			14034 "$errorcode:Omnis error code associated with the last action"
			14035 "$waitforcomplete:If kTrue, the worker object cannot be re-used until the current delegate object terminates. If kFalse,the delegate will be detached if the object is re-used before the delegate thread terminates"
			14036 "$nativeerrorcode:DBMS-specific native error code associated with the last SQL transaction" //gra0964
			14037 "$nativeerrortext:DBMS-specific native error text associated with the last SQL transaction" //gra0964
			
			//DAM Statement worker parameters //gra0844
			14050 "Params" //$init()
			14051 "ObjectRef" //$sessionobject() gra0846b
			14052 "Results:A row variable containing the results of the request"	// rmm8461
			14053 "Progress:A row variable containing progress information about the request. It has a single column (Progress) containing the percentage complete" // rmm9446
//End-of-file
