Interface IDatabasePlugin

Interface for database plugins.

Namespace: Gossip.Plugins

Assembly: Gossip.dll

Syntax

public interface IDatabasePlugin

Methods

| Improve this Doc View Source

OnBuild(UsageDetails)

Executes when DatabaseConnectionProvider is built.

Declaration

void OnBuild(UsageDetails usageDetails)

Parameters

Type	Name	Description
UsageDetails	usageDetails	Library usage details

| Improve this Doc View Source

OnConnectionExceptionAsync(IConnectionDetails)

Executes when database connection handles an exception during connection

Declaration

Task OnConnectionExceptionAsync(IConnectionDetails connectionDetails)

Parameters

Type	Name	Description
IConnectionDetails	connectionDetails	Database connection details

Returns

Type	Description
Task

| Improve this Doc View Source

OnConnectionOpenAsync(IConnectionDetails, IExecutionDetails)

Executes when database connection has finished opening

Declaration

Task OnConnectionOpenAsync(IConnectionDetails connectionDetails, IExecutionDetails executionDetails)

Parameters

Type	Name	Description
IConnectionDetails	connectionDetails	Database connection details
IExecutionDetails	executionDetails	Execution details providing information about the query

Returns

Type	Description
Task

| Improve this Doc View Source

OnConnectionOpeningAsync(IConnectionDetails)

Executes when database connection is opening

Declaration

Task OnConnectionOpeningAsync(IConnectionDetails connectionDetails)

Parameters

Type	Name	Description
IConnectionDetails	connectionDetails	Database connection details

Returns

Type	Description
Task

| Improve this Doc View Source

OnDatabaseMonitorExecutedAsync(IDatabaseMonitorReport)

Executes when database monitor is executed.

Declaration

Task OnDatabaseMonitorExecutedAsync(IDatabaseMonitorReport databaseMonitorReport)

Parameters

Type	Name	Description
IDatabaseMonitorReport	databaseMonitorReport	IDatabaseMonitorReport

Returns

Type	Description
Task

| Improve this Doc View Source

OnDatabaseResolutionExceptionAsync(String)

Executes when database connection exception is resolved/handled

Declaration

Task OnDatabaseResolutionExceptionAsync(string database)

Parameters

Type	Name	Description
String	database	Database name

Returns

Type	Description
Task

| Improve this Doc View Source

OnQueryExecutedAsync(IConnectionDetails, IExecutionDetails, FunctionMetadata)

Executes when SQL query is complete

Declaration

Task OnQueryExecutedAsync(IConnectionDetails connectionDetails, IExecutionDetails executionDetails, FunctionMetadata metadata)

Parameters

Type	Name	Description
IConnectionDetails	connectionDetails	Database connection details
IExecutionDetails	executionDetails	Execution details providing information about the query
FunctionMetadata	metadata	Metadata

Returns

Type	Description
Task

| Improve this Doc View Source

OnQueryExecutingAsync(IConnectionDetails, FunctionMetadata)

Executes while SQL query is in progress

Declaration

Task OnQueryExecutingAsync(IConnectionDetails connectionDetails, FunctionMetadata metadata)

Parameters

Type	Name	Description
IConnectionDetails	connectionDetails	Database connection details
FunctionMetadata	metadata	Metadata

Returns

Type	Description
Task