VOOZH about

URL: https://www.cdata.com/kb/tech/postgresql-ado-mvc.rst

โ‡ฑ Build MVC Applications with Connectivity to PostgreSQL Data


Build MVC Applications with Connectivity to PostgreSQL Data

๐Ÿ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
This article shows how to use only the Entity Framework and the CData ADO.NET provider to access PostgreSQL from an ASP.NET MVC application.

In this article, we will guide you through the process of utilizing wizards within Visual Studio to seamlessly integrate the CData ADO.NET Provider for PostgreSQL into a basic MVC (Model, View, Controller) project.

Create the Entity Framework Model

Follow the steps below to save connection properties and map tables to entities in the data model.

  1. Create a new MVC project in Visual Studio. In this example, the project name is MvcPostgreSQLApp.
  2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the PostgreSQL Entity Framework provider for your project. See the "LINQ and Entity Framework" chapter in the help documentation for a guide.

    Note that MVC 3 scaffolding and MVC 4 scaffolding do not support Entity Framework 6. You can use your scaffolding with Entity Framework 6 by upgrading to the latest version of MVC.
  3. To add the .edmx file from the designer, right-click your Models folder and click Add New Item. Select ADO.NET Entity Data Model, name the model, and click Add. In this example, the name of the model is PostgreSQLModel.
  4. In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
  5. Click New Connection. Select CData PostgreSQL Data Source in the dialog that is displayed.
  6. Specify the required connection string properties.

    To connect to PostgreSQL, set the Server, Port (the default port is 5432), and Database connection properties and set the User and Password you wish to use to authenticate to the server. If the Database property is not specified, the data provider connects to the user's default database.

    SSH Connectivity for PostgreSQL

    You can use SSH (Secure Shell) to authenticate with PostgreSQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

    SSH Connections to PostgreSQL in Password Auth Mode

    To connect to PostgreSQL via SSH in Password Auth mode, set the following connection properties:

    • User: PostgreSQL User name
    • Password: PostgreSQL Password
    • Database: PostgreSQL database name
    • Server: PostgreSQL Server name
    • Port: PostgreSQL port number like 3306
    • UserSSH: "true"
    • SSHAuthMode: "Password"
    • SSHPort: SSH Port number
    • SSHServer: SSH Server name
    • SSHUser: SSH User name
    • SSHPassword: SSH Password

    SSH Connections to PostgreSQL in Public Key Auth Mode

    To connect to PostgreSQL via SSH in Password Auth mode, set the following connection properties:

    • User: PostgreSQL User name
    • Password: PostgreSQL Password
    • Database: PostgreSQL database name
    • Server: PostgreSQL Server name
    • Port: PostgreSQL port number like 3306
    • UserSSH: "true"
    • SSHAuthMode: "Public_Key"
    • SSHPort: SSH Port number
    • SSHServer: SSH Server name
    • SSHUser: SSH User name
    • SSHClientCret: the path for the public key certificate file

    A typical connection string is below:

    User=postgres;Password=admin;Database=postgres;Server=127.0.0.1;Port=5432;
    ๐Ÿ‘ The connection for the model. (QuickBooks is shown.)
  7. Name the connection and select whether to include sensitive information, such as connection credentials, in the connection string. For simplicity, this example saves sensitive information in Web.config. The connection settings are saved as PostgreSQLEntities.

    ๐Ÿ‘ The completed connection step in the ADO.NET Entity Data Model wizard. (A QuickBooks connection is shown.)
  8. Select the tables and views you need. In this example, Orders is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.๐Ÿ‘ Tables to be imported into the .edmx file. (QuickBooks is shown.)
  9. Build your project to complete this step.

Scaffold the Controller and Views

Once you've established the model and completed the project build, you can employ ASP.NET Scaffolding wizards to generate both the controller and the views.

  1. In Solution Explorer, right-click the controllers folder and click Add -> Controller. Select MVC 5 Controller with views, using Entity Framework.
  2. In the Add Controller dialog that is then displayed, select the following options:
    • Model class: Select a table you imported; for example, Orders.
    • Data context class: Select your context class.
  3. Leave the default values for the other fields. ๐Ÿ‘ Creating a new controller from an existing entity data model in the Add Controller dialog in MVC 5. (QuickBooks is shown.)
You can now access the list of Orders records at http://MySite/Orders. Next to each record are links to edit, delete, and see more information. You can also create new Orders records. With every state change the site picks up any data changes. ๐Ÿ‘ The live table. (QuickBooks is shown.)

Ready to get started?

Download a free trial of the PostgreSQL Data Provider to get started:

 Download Now

Learn more:

๐Ÿ‘ PostgreSQL Icon
PostgreSQL ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with PostgreSQL-compatible database engines.