C# Class Azavea.Open.DAO.PostgreSQL.PostgreSqlDescriptor

This class is a ConnectionDescriptor implementation for using FastDAO to communicate with a PostGreSQL / PostGIS database. Thought it is named "PostGreSqlDescriptor", it supports spatial queries and data if you have PostGIS installed.
Inheritance: Azavea.Open.DAO.SQL.AbstractSqlConnectionDescriptor, ITransactionalConnectionDescriptor
Show file Open project: azavea/net-dao-postgresql Class Usage Examples

Public Properties

Property Type Description
DEFAULT_ENCODING string
DEFAULT_PORT string

Public Methods

Method Description
BeginTransaction ( ) : ITransaction

Begins the transaction. Returns a transaction object that you should use for operations you wish to be part of the transaction. NOTE: You MUST call Commit or Rollback on the returned ITransaction when you are done.
CaseInsensitiveLikeOperator ( ) : string
ColumnAliasPrefix ( ) : string
ColumnAliasSuffix ( ) : string
CreateDataAccessLayer ( ) : IDaLayer
CreateNewAdapter ( IDbCommand cmd ) : DbDataAdapter
CreateNewConnection ( ) : DbConnection
HasCaseInsensitiveLikeOperator ( ) : bool
MakeConnectionString ( string server, string port, string database, string user, string password, string encoding ) : string

Assembles a PostGreSQL/PostGIS connection string that can be used to get a database connection. All the parameters are optional for the purposes of this method, although obviously it would be possible to create a useless connection string if you leave out important parameters.
MakeModulusClause ( string columnName ) : SqlClauseWithValue
MakeSequenceValueQuery ( string sequenceName ) : string
NeedAsForColumnAliases ( ) : bool
NeedToAliasColumns ( ) : bool
PostgreSqlDescriptor ( Config config, string component, ConnectionInfoDecryptionDelegate decryptionDelegate ) : System

This constructor reads all the appropriate values from our standard config file in the normal format.
PostgreSqlDescriptor ( string server, string port, string database, string user, string password, string encoding ) : System

Constructor that lets you pass everything as parameters rather than requiring a config.
SetParametersOnCommand ( IDbCommand cmd, IEnumerable parameters ) : void
TableAliasPrefix ( ) : string
TableAliasSuffix ( ) : string
ToCleanString ( ) : string
ToCompleteString ( ) : string
UsePooling ( ) : bool

Method Details

BeginTransaction() public method

Begins the transaction. Returns a transaction object that you should use for operations you wish to be part of the transaction. NOTE: You MUST call Commit or Rollback on the returned ITransaction when you are done.
public BeginTransaction ( ) : ITransaction
return ITransaction

CaseInsensitiveLikeOperator() public method

public CaseInsensitiveLikeOperator ( ) : string
return string

ColumnAliasPrefix() public method

public ColumnAliasPrefix ( ) : string
return string

ColumnAliasSuffix() public method

public ColumnAliasSuffix ( ) : string
return string

CreateDataAccessLayer() public method

public CreateDataAccessLayer ( ) : IDaLayer
return IDaLayer

CreateNewAdapter() public method

public CreateNewAdapter ( IDbCommand cmd ) : DbDataAdapter
cmd IDbCommand
return System.Data.Common.DbDataAdapter

CreateNewConnection() public method

public CreateNewConnection ( ) : DbConnection
return System.Data.Common.DbConnection

HasCaseInsensitiveLikeOperator() public method

public HasCaseInsensitiveLikeOperator ( ) : bool
return bool

MakeConnectionString() public static method

Assembles a PostGreSQL/PostGIS connection string that can be used to get a database connection. All the parameters are optional for the purposes of this method, although obviously it would be possible to create a useless connection string if you leave out important parameters.
public static MakeConnectionString ( string server, string port, string database, string user, string password, string encoding ) : string
server string Server name that is hosting the database
port string Port number on the server to use, if you don't know then use DEFAULT_PORT.
database string Database name, if necessary to specify
user string User name to use when accessing the db
password string Password for above user, in plain text.
encoding string String encoding to use, if you don't know then use DEFAULT_ENCODING.
return string

MakeModulusClause() public method

public MakeModulusClause ( string columnName ) : SqlClauseWithValue
columnName string
return Azavea.Open.DAO.SQL.SqlClauseWithValue

MakeSequenceValueQuery() public method

public MakeSequenceValueQuery ( string sequenceName ) : string
sequenceName string
return string

NeedAsForColumnAliases() public method

public NeedAsForColumnAliases ( ) : bool
return bool

NeedToAliasColumns() public method

public NeedToAliasColumns ( ) : bool
return bool

PostgreSqlDescriptor() public method

This constructor reads all the appropriate values from our standard config file in the normal format.
public PostgreSqlDescriptor ( Config config, string component, ConnectionInfoDecryptionDelegate decryptionDelegate ) : System
config Azavea.Open.Common.Config Config to get params from.
component string Section of the config XML to look in for db params.
decryptionDelegate ConnectionInfoDecryptionDelegate Delegate to call to decrypt password fields. /// May be null if passwords are in plain text.
return System

PostgreSqlDescriptor() public method

Constructor that lets you pass everything as parameters rather than requiring a config.
public PostgreSqlDescriptor ( string server, string port, string database, string user, string password, string encoding ) : System
server string Server name or IP. May not be null.
port string Port number on the server. Null means use the default.
database string Database name on that server. May not be null.
user string Database user name, may be null.
password string Plain text password for the user. /// May be null.
encoding string String encoding to use. Null means use the default (unicode).
return System

SetParametersOnCommand() public method

public SetParametersOnCommand ( IDbCommand cmd, IEnumerable parameters ) : void
cmd IDbCommand
parameters IEnumerable
return void

TableAliasPrefix() public method

public TableAliasPrefix ( ) : string
return string

TableAliasSuffix() public method

public TableAliasSuffix ( ) : string
return string

ToCleanString() public method

public ToCleanString ( ) : string
return string

ToCompleteString() public method

public ToCompleteString ( ) : string
return string

UsePooling() public method

public UsePooling ( ) : bool
return bool

Property Details

DEFAULT_ENCODING public static property

This is the "usual" character encoding that PostGreSQL uses. Unless you know your instance is using a different encoding, this is the one you should use.
public static string DEFAULT_ENCODING
return string

DEFAULT_PORT public static property

This is the "usual" port that PostGreSQL runs on. Unless you know your instance is running on a different port, this is the one you should use.
public static string DEFAULT_PORT
return string