Ready to get started?

Learn more about the CData ADO.NET Provider for Phoenix or download a free trial:

Download Now

Build MVC Applications with Connectivity to Phoenix Data

This article shows how to use only the Entity Framework and the CData ADO.NET provider to access Phoenix from an ASP.NET MVC application.

This article shows how to use wizards in Visual Studio to drop the CData ADO.NET Provider for Phoenix into a simple 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 MvcApachePhoenixApp.
  2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the Phoenix 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 ApachePhoenixModel.
  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 Phoenix Data Source in the dialog that is displayed.
  6. Specify the required connection string properties.

    Connect to Apache Phoenix via the Phoenix Query Server. Set the Server and Port (if different from the default port) properties to connect to Apache Phoenix. The Server property will typically be the host name or IP address of the server hosting Apache Phoenix.

    Authenticating to Apache Phoenix

    By default, no authentication will be used (plain). If authentication is configured for your server, set AuthScheme to NEGOTIATE and set the User and Password properties (if necessary) to authenticate through Kerberos.

    A typical connection string is below:

    Server=localhost;Port=8765;
  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 ApachePhoenixEntities.

  8. Select the views you need. In this example, MyTable is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.
  9. Build your project to complete this step.

Scaffold the Controller and Views

After creating the model and building the project, you can use ASP.NET Scaffolding wizards to create 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, MyTable.
    • Data context class: Select your context class.
  3. Leave the default values for the other fields.

You can now access the list of MyTable records at http://MySite/MyTable. With every state change the site picks up any data changes.