dataStore.getInfo( )

Home

4D v18

Description

The dataStore.getInfo( ) method returns an object providing information about the datastore. This method is useful for setting up generic code.

Returned object

Property

Type

Description

type

string

"4D": main datastore, available through ds
"4D Server": remote datastore, open with Open datastore

networked

boolean

True: the datastore is reached through a network connection.
False: the datastore is not reached through a network connection (local database)

localId

text

ID of the datastore on the machine. Corresponds to the localId string given with the Open datastore command. Empty string ("") for main datastore.

connection

object

Object describing the remote datastore connection (not returned for main datastore). Available properties:

Property	Type	Description
hostname	text	IP address or name of the remote datastore + ":" + port number
tls	boolean	True if secured connection is used with the remote datastore
idleTimeout	number	Session inactivity timeout (in minutes)
user	text	User authenticated on the remote datastore

If the dataStore.getInfo( ) method is executed on a 4D Server or 4D single-user, networked is False.
If the dataStore.getInfo( ) method is executed on a remote 4D, networked is True

Example 1

 C_OBJECT($info)

 

 $info:=ds.getInfo() //Executed on 4D Server or 4D

  //{"type":"4D","networked":false,"localID":""}

 

 $info:=ds.getInfo() // Executed on 4D remote

  //{"type":"4D","networked":true,"localID":""}

Example 2

On a remote datastore:

 C_OBJECT($info;$connectTo;$remoteDS)

 

 $connectTo:=New object("hostname";"111.222.33.44:8044";"user";"marie";"password";"aaaa")

 $remoteDS:=Open datastore($connectTo;"students")

 $info:=$remoteDS.getInfo()

 

  //{"type":"4D Server",

  //"localID":"students",

  //"networked":true,

  //"connection":{hostname:"111.222.33.44:8044","tls":false,"idleTimeout":2880,"user":"marie"}}