TdxBackendDatabaseSQLConnection.ConnectionString Property

Specifies a connection string.

Declaration

property ConnectionString: string read; write;

Property Value

Type	Description
string	A connection string.

Remarks

A connection string specifies the target database (SQL Server, PostgreSQL, SQLite, etc.) and all parameters required for connections.

Assign a valid connection string for a supported SQL database to the ConnectionString and enable the Active property to connect the TdxBackendDatabaseSQLConnection component to the database.

Code Examples

Connect to an SQL Database and Edit Report Templates

The following code example uses the TdxBackendDatabaseSQLConnection component to connect to a demo database (nwind.mdb), displays the Report Designer dialog, and saves all changes made to the UserReport.repx file:

Delphi

uses
  dxReport,  // Declares the TdxReport component and related types
  dxBackend.ConnectionString.SQL;  // Declares the TdxBackendDatabaseSQLConnection component
// ...

procedure TMyForm.Button1Click(Sender: TObject);
var
  ADataConnection: TdxBackendDatabaseSQLConnection;
  AReport: TdxReport;
begin
  ADataConnection := TdxBackendDatabaseSQLConnection.Create(Self);
  try
    ADataConnection.Name := 'DataConnection';
    // Specify a connection string required to connect to a demo database (nwind.mdb)
    ADataConnection.ConnectionString := 'XpoProvider=MSAccess;Provider=Microsoft.ACE.OLEDB.12.0;' +
      'Data Source=C:\Users\Public\Documents\DevExpress VCL Demos\' +
      'MegaDemos\Product Demos\ExpressPivotGrid\Data\nwind.mdb';
    AReport := TdxReport.Create(Self);
    try
      AReport.ShowDesigner;  // Displays the Web-based Report Designer dialog
      AReport.Layout.SaveToFile('UserReport.repx');  // Saves the report template state to a file
    finally
      AReport.Free;
    end;
  finally
    ADataConnection.Free;
  end;
end;

C++

#include "dxReport.hpp"  // Declares the TdxReport component and related types
#include "dxBackend.ConnectionString.SQL.hpp"  // Declares the TdxBackendDatabaseSQLConnection component

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxReport"  // Required to use dxReport.hpp declarations
#if defined(_WIN64)  // Required to use dxBackend.ConnectionString.SQL.hpp declarations
  #pragma link "dxBackend.ConnectionString.SQL.o"
#else
  #pragma link "dxBackend.ConnectionString.SQL.obj"
// ...

void __fastcall TMyForm::Button1Click(TObject *Sender)
{
  TdxBackendDatabaseSQLConnection *ADataConnection;
  TdxReport *AReport;
  ADataConnection = new TdxBackendDatabaseSQLConnection(this);
  try
  {
    ADataConnection->Name = "DataConnection";
    // Specify a connection string required to connect to a demo database (nwind.mdb)
    ADataConnection->ConnectionString = "XpoProvider=MSAccess;Provider=Microsoft.ACE.OLEDB.12.0;"
      "Data Source=C:\\Users\\Public\\Documents\\DevExpress VCL Demos\\MegaDemos\\"
      "Product Demos\\ExpressPivotGrid\\Data\\nwind.mdb";
    AReport = new TdxReport(this);
    try
    {
      AReport->ShowDesigner();  // Displays the Report Designer dialog
      AReport->Layout->SaveToFile("UserReport.repx");  // Saves the report template state to a file
    }
    __finally
    {
      delete AReport;
    }
  }
  __finally
  {
    delete ADataConnection;
  }
}

Specify a PostgreSQL Connection String

The following code example demonstrates an OnClick event handler that configures a TdxBackendDatabaseSQLConnection component to access postgres (a test PostgreSQL database) and displays the Dashboard Designer dialog:

Delphi

uses
  dxDashboard.Control,  // Declares the TdxDashboardControl component
  dxBackend.ConnectionString.SQL;  // Declares the TdxBackendDatabaseSQLConnection component
// ...

procedure TMyForm.cxButton1Click(Sender: TObject);
begin
  dxBackendDatabaseSQLConnection1.Active := False;  // Terminates the current connection (if one exists)
  // Specify a user-friendly data connection name (for end-user dialogs) and a valid connection string
  dxBackendDatabaseSQLConnection1.DisplayName := 'PostgreSQL Database Connection';
  dxBackendDatabaseSQLConnection1.ConnectionString :=

    'XpoProvider=Postgres;' +  // Specifies the database engine type
    'Server=127.0.0.1;' +  // Specifies the database host IP address
    'User ID=myuser;' +  // Specifies a valid user name
    'Password=123;' +  // Specifies the corresponding password for the user name
    'Database=dashboard_test;' +  // Specifies the target database name
    'Encoding=UNICODE';  // Sets UTF-8 as the required encoding

  dxBackendDatabaseSQLConnection1.Active := True;  // Connects to the "postgres" database
  dxDashboardControl1.ShowDesigner;  // Displays the Dashboard Designer dialog
end;

C++

#include "dxDashboard.Control.hpp"  // Declares the TdxDashboardControl component
#include "dxBackend.ConnectionString.SQL.hpp"  // Declares the TdxBackendDatabaseSQLConnection component

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxDashboard.Control"  // Required to use dxDashboard.Control.hpp declarations
#if defined(_WIN64)  // Required to use dxBackend.ConnectionString.SQL.hpp declarations
  #pragma link "dxBackend.ConnectionString.SQL.o"
#else
  #pragma link "dxBackend.ConnectionString.SQL.obj"
#endif
// ...

void __fastcall TMyForm::cxButton1Click(TObject *Sender)
{
  dxBackendDatabaseSQLConnection1->Active = false; // Terminates the current connection (if one exists)
  // Specify a user-friendly data connection name (for end-user dialogs) and a valid connection string
  dxBackendDatabaseSQLConnection1->DisplayName = "PostgreSQL Database Connection";
  dxBackendDatabaseSQLConnection1->ConnectionString =

    L"XpoProvider=Postgres;"  // Specifies the database engine type
    L"Server=127.0.0.1;"  // Specifies the database host IP address
    L"User ID=myuser;"  // Specifies a valid user name
    L"Password=123;"  // Specifies the corresponding password for the user name
    L"Database=dashboard_test;"  // Specifies the target database name
    L"Encoding=UNICODE";  // Sets UTF-8 as the required encoding

  dxBackendDatabaseSQLConnection1->Active = true;  // Connects to the "postgres" database
  dxDashboardControl1->ShowDesigner();  // Displays the Dashboard Designer dialog
}

Connect to a Firebird SQL Database

The following code example demonstrates an OnClick event handler that configures a TdxBackendDatabaseSQLConnection component used to access the EMPLOYEE.FDB test Firebird database and to display the Dashboard Designer dialog:

Delphi

uses
  dxDashboard.Control,  // Declares the TdxDashboardControl component
  dxBackend.ConnectionString.SQL;  // Declares the TdxBackendDatabaseSQLConnection component
// ...

procedure TMyForm.cxButton1Click(Sender: TObject);
begin
  dxBackendDatabaseSQLConnection1.Active := False;  // Terminates the current connection (if one exists)
  // Specify a user-friendly data connection name (for end-user dialogs) and a valid connection string
  dxBackendDatabaseSQLConnection1.DisplayName := 'Firebird Database Connection';
  dxBackendDatabaseSQLConnection1.ConnectionString :=

    'XpoProvider=Firebird;' +  // Specifies the database engine type
    'Datasource=localhost;' +  // Specifies the database location (IP 127.0.0.1)
    'User=SYSDBA;' +  // Specifies a valid user name
    'Password=password;' +  // Specifies the corresponding password for the user names
    'Database=C:\Program Files\Firebird\Firebird_5_0\examples\empbuild\EMPLOYEE.FDB;' +
    'ServerType=0;Charset=NONE';  // Specifies additional parameters

  dxBackendDatabaseSQLConnection1.Active := True;  // Connects to the EMPLOYEE.FDB database
  dxDashboardControl1.ShowDesigner;  // Displays the Dashboard Designer dialog
end;

C++

#include "dxDashboard.Control.hpp"  // Declares the TdxDashboardControl component
#include "dxBackend.ConnectionString.SQL.hpp"  // Declares the TdxBackendDatabaseSQLConnection component

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxDashboard.Control"  // Required to use dxDashboard.Control.hpp declarations
#if defined(_WIN64) // Required to use dxBackend.ConnectionString.SQL.hpp declarations
  #pragma link "dxBackend.ConnectionString.SQL.o"
#else
  #pragma link "dxBackend.ConnectionString.SQL.obj"
#endif
// ...

void __fastcall TMyForm::cxButton1Click(TObject *Sender)
{
  dxBackendDatabaseSQLConnection1->Active = false;  // Terminates the current connection (if one exists)
  // Specify a user-friendly data connection name (for end-user dialogs) and a valid connection string
  dxBackendDatabaseSQLConnection1->DisplayName = "Firebird Database Connection";
  dxBackendDatabaseSQLConnection1->ConnectionString =

    L"XpoProvider=Firebird;"  // Specifies the database engine type
    L"Datasource=localhost;"  // Specifies the database location (IP 127.0.0.1)
    L"User=SYSDBA;"  // Specifies a valid user name
    L"Password=password;"  // Specifies the corresponding password for the user name
    L"Database=C:\\Program Files\\Firebird\\Firebird_5_0\\examples\\empbuild\\EMPLOYEE.FDB;"
    L"ServerType=0;Charset=NONE"; // Specifies additional parameters

  dxBackendDatabaseSQLConnection1->Active = true; // Connects to the EMPLOYEE.FDB database
  dxDashboardControl1->ShowDesigner();  // Displays the Dashboard Designer dialog
}

Default Value

The ConnectionString property’s default value is an empty string.