Back to Devexpress

MSSqlConnectionProvider.GetConnectionString(String, String) Method

xpo-devexpress-dot-xpo-dot-db-dot-mssqlconnectionprovider-dot-getconnectionstring-x28-system-dot-string-system-dot-string-x29.md

latest9.0 KB
Original Source

MSSqlConnectionProvider.GetConnectionString(String, String) Method

Returns a connection string used to open a specified Microsoft SQL database using Windows Integrated Security.

Namespace : DevExpress.Xpo.DB

Assembly : DevExpress.Xpo.v25.2.dll

NuGet Package : DevExpress.Xpo

Declaration

csharp
public static string GetConnectionString(
    string server,
    string database
)
vb
Public Shared Function GetConnectionString(
    server As String,
    database As String
) As String

Parameters

NameTypeDescription
serverString

A string that specifies the SQL server name.

| | database | String |

A string that specifies the database name.

|

Returns

TypeDescription
String

A connection string.

|

Remarks

The value returned by this method can be used to initialize a Session’s connection string (for instance, via the Session.ConnectionString or XpoDefault.ConnectionString property).

Note

The string returned by the GetConnectionString method contains an extra parameter that identifies the database type to which a connection should be established, so it’s not fully compatible with the standard connection string format. When a Session receives this connection string, it removes this extra parameter and then passes the valid connection string to the database.

Example

The following code demonstrates how to connect to an Microsoft SQL database. The MSSqlConnectionProvider.GetConnectionString method is called to construct a connection string to the database. It is then assigned to the default session via the Session.ConnectionString property.

csharp
using DevExpress.Xpo;
using DevExpress.Xpo.DB;

Session.DefaultSession.ConnectionString = MSSqlConnectionProvider.GetConnectionString(
    "SERVER", "sa", "", "Northwind");
vb
Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB

Session.DefaultSession.ConnectionString = MSSqlConnectionProvider.GetConnectionString( _
    "SERVER", "sa", "", "Northwind")

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetConnectionString(String, String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XPO_how-to-create-a-data-caching-service-that-helps-improve-performance-in-distributed-e4932/CS/WcfService1/Service1.svc.cs#L14

csharp
static Service1() {
    string connectionString = MSSqlConnectionProvider.GetConnectionString("localhost", "ServiceDB");
    IDataStore dataStore = XpoDefault.GetConnectionProvider(connectionString, AutoCreateOption.DatabaseAndSchema);

XPO_how-to-read-and-manipulate-xpo-objects-stored-in-multiple-databases-simultaneously-t475838/CS/ConsoleApplication/Program.cs#L61

csharp
static IDataLayer SetupDB1() {
    string connString = MSSqlConnectionProvider.GetConnectionString("(local)", "SampleDB1");
    XPDictionary dict = new ReflectionDictionary();

XPO_how-to-filter-an-associated-collection-in-legacy-xpo-versions-e876/CS/Program.cs#L21

csharp
private static void InitDal() {
    string conn = MSSqlConnectionProvider.GetConnectionString("(local)", "Northwind");
    XpoDefault.DataLayer = XpoDefault.GetDataLayer(conn, AutoCreateOption.SchemaAlreadyExists);

wpf-data-grid-in-server-mode-with-xpo/CS/XpoNorthwindServerMode/Window1.xaml.cs#L23

csharp
public Window1() {
    string conn = MSSqlConnectionProvider.GetConnectionString("(local)", "NorthwindXpo");
    XpoDefault.DataLayer = XpoDefault.GetDataLayer(conn, AutoCreateOption.SchemaAlreadyExists);

winforms-grid-implement-crud-operations-xpinstantfeedbacksource/CS/DXServermode2/Form1.cs#L67

csharp
{
    session1 = new Session() { ConnectionString = MSSqlConnectionProvider.GetConnectionString("(local)", "NorthWind") };
    session1.Connect();

XPO_how-to-create-a-data-caching-service-that-helps-improve-performance-in-distributed-e4932/VB/WcfService1/Service1.svc.vb#L13

vb
Shared Sub New()
    Dim connectionString As String = MSSqlConnectionProvider.GetConnectionString("localhost", "ServiceDB")
    Dim dataStore As IDataStore = XpoDefault.GetConnectionProvider(connectionString, AutoCreateOption.DatabaseAndSchema)

XPO_how-to-read-and-manipulate-xpo-objects-stored-in-multiple-databases-simultaneously-t475838/VB/ConsoleApplication/Program.vb#L61

vb
Private Shared Function SetupDB1() As IDataLayer
    Dim connString As String = MSSqlConnectionProvider.GetConnectionString("(local)", "SampleDB1")
    Dim dict As XPDictionary = New ReflectionDictionary()

XPO_how-to-import-a-large-data-set-using-xpo-efficiently-within-a-transaction-t333879/VB/XpoImport/Program.vb#L40

vb
Dim classes = dict.CollectClassInfos(GetType(SampleObject).Assembly)
Dim provider = XpoDefault.GetConnectionProvider(DevExpress.Xpo.DB.MSSqlConnectionProvider.GetConnectionString("localhost", "XpoImportHelperTest"), Xpo.DB.AutoCreateOption.DatabaseAndSchema)
Dim dal = New SimpleDataLayer(dict, provider)

XPO_how-to-filter-an-associated-collection-in-legacy-xpo-versions-e876/VB/Program.vb#L24

vb
Private Shared Sub InitDal()
    Dim conn As String = MSSqlConnectionProvider.GetConnectionString("(local)", "Northwind")
    XpoDefault.DataLayer = XpoDefault.GetDataLayer(conn, AutoCreateOption.SchemaAlreadyExists)

wpf-data-grid-in-server-mode-with-xpo/VB/XpoNorthwindServerMode/Window1.xaml.vb#L15

vb
Public Sub New()
    Dim conn As String = MSSqlConnectionProvider.GetConnectionString("(local)", "NorthwindXpo")
    XpoDefault.DataLayer = XpoDefault.GetDataLayer(conn, AutoCreateOption.SchemaAlreadyExists)

See Also

Session.ConnectionString

XpoDefault.ConnectionString

MSSqlConnectionProvider Class

MSSqlConnectionProvider Members

DevExpress.Xpo.DB Namespace