SiMX Help‎ > ‎The Target Platform‎ > ‎Objects‎ > ‎

DB Object



The DB Object is a database object that provides the basic database access functionality.


You can create it in the scripting panel by right click -> data properties -> DB. After the DB object is created, typing "DB." Will reveal the following fly menu:

Please select a property or method below to learn more about it:

DB.DS
alias
clsid
csv_col_separator
csv_include_column_names
csv_positional
csv_text_qualifier
database
dsn
extension
password
schema
table
user
valid
CallFunction
CallProcedure
Create
Drop
Execute
Format
GetAsString
GetCustomSelect
GetFieldNames
GetFrom
GetRelation
GetTableNames
LoadFields
ReplaceTable
SetCustomSelect
SetDS
SetParam
TableExists

DB.group
summary
Get
Remove
Set
ShowTotals

DB.scope
distinct
Get
HasSyntaxCheck
Join
MakeCondition1
MakeCondition2
Modify
Set

DB.sort
Add
Flush
Get
Modify
Remove
Replace
Set

DB.AddField
DB.AppendFinish
DB.AppendStart
DB.Clone
DB.Close
DB.CopyRecord
DB.CopyTo
DB.Create
DB.DeleteRecords
DB.Find
DB.FlushFields
DB.GetFieldComment
DB.GetFieldCount
DB.GetFieldDefinition
DB.GetFieldName
DB.GetFieldNames
DB.GetFieldType
DB.GetFieldValue
DB.GetRecordCount
DB.GetRecordNumber
DB.GetStatistics
DB.GetTopN
DB.GetValues
DB.GetVisible
DB.GoBottom
DB.GoNext
DB.GoPrevious
DB.GoRandom
DB.GoTop
DB.IsFieldEmpty
DB.Select
DB.SetFieldDefinition
DB.SetFieldFormat
DB.SetFieldLen
DB.SetFieldName
DB.SetFieldValue
DB.SetRecordID
DB.SetTopN
DB.SetVisible
DB.TransactionFinish
DB.TransactionStart
DB.UpdateFinish
DB.UpdateFinishASync
DB.UpdateStart

Examples:

You can set output table using two methods: setting the table name (assuming you are connected to a database) - (a) and setting the entire data source - (b):

If you are writing script outside TextConverter the API looks like this: 

Set DS = TextConverter.GetOutputDS()

DS.table = "tablename" )               ‘- (a)

DS.SetDS( "c:\data\output.dbf" )       ‘- (b)

 

If you are writing script inside TextConverter it looks like this:

This.DSOut.table = "tablename" )             ‘- (a)

This.DSOut.SetDS( "c:\data\output.dbf" )     ‘- (b)

      

      An Excel file is also considered as a database, so you can set the worksheet as:

   Set DS = TextConverter.GetOutputDS()

   DS.table = "worksheetname" )               ‘- (a)

DS.SetDS( "...\file.mdb:worksheetname" )   ‘- (b)


Back (Value Object) | Next (DBCreator Object)

Back (Objects and Methods)