fmewebservices.FMEDatabaseConnection

FMEDatabaseConnection.clearNameValues()	Clears all values associated with this connection.
FMEDatabaseConnection.getFamilyName()	Retrieves the family name associated with this connection.
FMEDatabaseConnection.getId()	Gets the database generated id for this connection.
FMEDatabaseConnection.getName()	Retrieves the name of this named connection, which is unique for the given authorized users.
FMEDatabaseConnection.getNameValues()	Retrieves the name values associated with this connection.
FMEDatabaseConnection.getOwnerName()	Gets the owner (user) of this named connection.
FMEDatabaseConnection.getServiceName()	Gets the owner (user) of this named connection.
FMEDatabaseConnection.getType()	Retrieves the type of the named connection.
FMEDatabaseConnection.setFamilyName(name)	Sets the family name associated with this connection.
FMEDatabaseConnection.setId(name)	Sets the database generated id for this connection.
FMEDatabaseConnection.setName(name)	Sets the name of this named connection, which is not committed to the DB until this named connection is passed back to the manager.
FMEDatabaseConnection.setNameValues(nameValues)	Sets the name values associated with this connection.
FMEDatabaseConnection.setOwnerName(name)	Sets the owner (user) of this named connection.

class FMEDatabaseConnection

FME Database Connection class.

init(serviceName)

Create an instance of a database connection object.

Parameters:

serviceName (str) – The service name of the connection.

__init__(*args, **kwargs)

clearNameValues()

Clears all values associated with this connection.

Return type:

None

getFamilyName()

Retrieves the family name associated with this connection.

Return type:

str

Returns:

The family name.

getId()

Gets the database generated id for this connection.

Return type:

str

Returns:

The database generated id for the named connection.

getName()

Retrieves the name of this named connection, which is unique for the given authorized users. This is the name given to the connection by the user.

Return type:

str

Returns:

The name of the named connection.

getNameValues()

Retrieves the name values associated with this connection. The names are the keys and the values are the values in the returned dict.

Return type:

dict

Returns:

The name values.

getOwnerName()

Gets the owner (user) of this named connection.

Return type:

str

Returns:

The owner of the named connection.

getServiceName()

Gets the owner (user) of this named connection.

Return type:

str

Returns:

The owner of the named connection.

getType()

Retrieves the type of the named connection.

Returns one of FME_NAMEDCONNECTION_DATABASE, FME_NAMEDCONNECTION_BASIC, FME_NAMEDCONNECTION_OAUTH, FME_NAMEDCONNECTION_TOKEN, or FME_NAMEDCONNECTION_WEBSERVICE.

Return type:

int

Returns:

The type of the named connection.

setFamilyName(name)

Sets the family name associated with this connection.

Parameters:

name (str) – The family name.

Return type:

None

setId(name)

Sets the database generated id for this connection.

Parameters:

name (str) – The database generated id to set for the named connection.

Return type:

None

setName(name)

Sets the name of this named connection, which is not committed to the DB until this named connection is passed back to the manager.

Parameters:

name (str) – The name to set on the named connection.

Return type:

None

setNameValues(nameValues)

Sets the name values associated with this connection. Will append a new name, and update existing values, and will not delete existing values. The names are the keys and the values are the values in the dict parameter.

Parameters:

nameValues (dict) – The name values.

Return type:

None

setOwnerName(name)

Sets the owner (user) of this named connection.

Parameters:

name (str) – The name to set as the owner of the named connection.

Return type:

None