C1JsonConnection Class

<xref href="C1.AdoNet.Json.C1JsonConnection" data-throw-if-not-resolved="false"></xref> represents a connection to a Json server.

The connection can be used to query the data hosted by the server or request modifications.

Inheritance

object

C1ConnectionBase<C1JsonConnection>

C1JsonConnection

Implements

Namespace: C1.AdoNet.Json

Assembly: C1.AdoNet.Json.dll

Syntax

public sealed class C1JsonConnection : C1ConnectionBase<C1JsonConnection>, IComponent, IDbConnection, IDisposable, IAsyncDisposable

Public NotInheritable Class C1JsonConnection
    Inherits C1ConnectionBase(Of C1JsonConnection)
    Implements IComponent, IDbConnection, IDisposable, IAsyncDisposable

Constructors

Name	Description
C1JsonConnection()	Creates a new C1JsonConnection instance.
C1JsonConnection(C1JsonConnectionStringBuilder)	Initialize a new C1JsonConnection instance using the specified connection string. expressed in a C1JsonConnectionStringBuilder.
C1JsonConnection(string)	Initialize a new C1JsonConnection instance using the specified connection string.

Properties

Name	Description
ApiConfigFile	The path to the config file for http/https Json source.
DataModel	Specifies the data model to use when parsing JSON documents and generating the database metadata.
DataSource	Gets the name of the database server to which to connect.
Database	Gets the name of the current database after a connection is opened, or the database name specified in the connection string before the connection is opened.
JsonPath	The JsonPath of an array element that defines the separation of rows.
ServerVersion	Gets a string that represents the version of the server to which the object is connected.
Uri	The Uniform Resource Identifier (URI) for the JSON resource location.

Methods

Name	Description
BeginDbTransaction(IsolationLevel)	Begins a transaction on the connection.
ChangeDatabase(string)	Changes the current database for an open connection.
Close()	Closes the connection to the database. This is the preferred method of closing any open connection.
CreateDbCommand()	Creates and returns a DbCommand object associated with the current connection.
GetColumnsSchema(string[])	Retrieve the metadata relatively to the columns.
GetIndexColumns(string[])	Retrieve the metadata relatively to the index columns.
GetIndexesSchema(string[])	Retrieve the metadata relatively to the indexes.
GetPrimaryKeySchema(string[])	Retrieve the metadata relatively to the primary keys.
GetTablesSchema(string[])	Retrieve the metadata relatively to the tables.
OnConnectionStringChanged()	A method that is executed everytime that the connection string used by this C1JsonConnectionStringBuilder has changed.
Open()	Opens a database connection with the settings specified by the connection string.
OpenAsync(CancellationToken)	An asynchronous version of Open() open.