Class SQLServerDataProvider

Gets the current configuration data for this provider instance

Gets the underlying SQL Server connection pool

For the SQLServerDataProvider the unique instance connection string which is used to identify, uniquely, a given connection is the following format: mssql://host:port/instanceName?/database instanceName is only inserted if it is provided in the options

Gets the local storage provider implementation. Must be implemented by subclasses to provide environment-specific storage.

Gets the MemberJunction core schema name (defaults to __mj if not configured)

Checks if we're currently in a nested transaction (depth > 1)

Checks if we're currently in a transaction (at any depth)

Gets whether a transaction is currently active

Gets the current savepoint names in the stack (for debugging) Returns a copy to prevent external modification

Gets the current transaction nesting depth 0 = no transaction, 1 = first level, 2+ = nested transactions

Observable that emits the current transaction state (true when active, false when not) External code can subscribe to this to know when transactions start and end

Example

provider.transactionState$.subscribe(isActive => {
  console.log('Transaction active:', isActive);
});
Copy

Begins a transaction for the current database connection.

Commits the current transaction.

Configures the SQL Server data provider with connection settings and initializes the connection pool

Creates a new SQL logging session that will capture all SQL operations to a file. Returns a disposable session object that must be disposed to stop logging.

Example

// Basic usage
const session = await provider.CreateSqlLogger('./logs/metadata-sync.sql');
try {
  // Perform operations that will be logged
  await provider.ExecuteSQL('INSERT INTO ...');
} finally {
  await session.dispose(); // Stop logging
}

// With migration formatting
const session = await provider.CreateSqlLogger('./migrations/changes.sql', {
  formatAsMigration: true,
  description: 'MetadataSync push operation'
});
Copy

Creates a new transaction group for managing database transactions. Must be implemented by subclasses to provide transaction support.

This method will create a human-readable string that describes the changes object that was created using the DiffObjects() method

Creates a changes object by comparing two javascript objects, identifying fields that have different values. Each property in the returned object represents a changed field, with the field name as the key.

Remarks

• Read-only fields are never considered changed
• null and undefined are treated as equivalent
• Date fields are compared by timestamp
• String and object values have quotes properly escaped for SQL
• Objects/arrays are recursively escaped using escapeQuotesInProperties

Example

const changes = provider.DiffObjects(
  { name: "John's Co", revenue: 1000 },
  { name: "John's Co", revenue: 2000 },
  entityInfo,
  "'"
);
// Returns: { revenue: { field: "revenue", oldValue: 1000, newValue: 2000 } }
Copy

Dispose of this provider instance and clean up resources. This should be called when the provider is no longer needed.

Disposes all active SQL logging sessions. Useful for cleanup on provider shutdown.

This method can be used to execute raw SQL statements outside of the MJ infrastructure. CAUTION - use this method with great care.

Executes multiple SQL queries in a single batch for optimal performance. All queries are combined into a single SQL statement and executed together. This is particularly useful for bulk operations where you need to execute many similar queries and want to minimize round trips to the database.

Gets information about all active SQL logging sessions. Useful for monitoring and debugging.

Returns the stored procedure name to use for the given entity based on if it is a new record or an existing record.

Gets the current user information from the provider. Must be implemented by subclasses to return user-specific data.

Retrieves the date status information for a dataset and all its items from the server. This method will match the datasetName and itemFilters to the server's dataset and item filters to determine a match

Returns the Name of the specific recordId for a given entityName. This is done by looking for the IsNameField within the EntityFields collection for a given entity. If no IsNameField is found, but a field called "Name" exists, that value is returned. Otherwise null returned

Returns one or more record names using the same logic as GetEntityRecordName, but for multiple records at once - more efficient to use this method if you need to get multiple record names at once

Returns a list of dependencies - records that are linked to the specified Entity/RecordID combination. A dependency is as defined by the relationships in the database. The MemberJunction metadata that is used for this simply reflects the foreign key relationships that exist in the database. The CodeGen tool is what detects all of the relationships and generates the metadata that is used by MemberJunction. The metadata in question is within the EntityField table and specifically the RelatedEntity and RelatedEntityField columns. In turn, this method uses that metadata and queries the database to determine the dependencies. To get the list of entity dependencies you can use the utility method GetEntityDependencies(), which doesn't check for dependencies on a specific record, but rather gets the metadata in one shot that can be used for dependency checking.

Returns a list of record IDs that are possible duplicates of the specified record.

Checks if a specific record is marked as a favorite by the user.

Generates the SQL Statement that will Save a record to the database.

This method is used by the Save() method of this class, but it is marked as public because it is also used by the SQLServerTransactionGroup to regenerate Save SQL if any values were changed by the transaction group due to transaction variables being set into the object.

Security

This method handles field-level encryption transparently. Fields marked with Encrypt=true will have their values encrypted before being included in the SQL statement.