Using SQL Adapters with Ensemble - InterSystems Documentation

About the Ensemble SQL Adapters1.2 Helper ClassesEnsemble provides two helper classes that are used as arguments and return values for the built-inSQL methods:• The EnsLib.SQL.GatewayResultSet class represents a special-purpose result set for use inEnsemble. An initialized instance of this class has a live data connection to a data source. Theclass provides methods to examine the contents of the result set as well as a method to return astatic snapshot.• The EnsLib.SQL.Snapshot class represents a static object that you can create and populate in variousways. For example, you can populate it with the data of a result set, either all the rows or asubset of rows (starting at some row position). Or you can populate it with the contents of a fileor stream. Or you can construct it row by row.The class provides methods for examining the data; more methods are available for this objectthan for the result set.1.3 General UseAt a high level, to include an adapter in a production, you do the following:• Create a business host (specifically a business service or business operation) class that uses theadapter. You use the ADAPTER parameter of the business host class to specify the adapter to use.• Within that class, implement the methods you need. Your methods will typically use the propertiesand methods of the associated adapter, via the Adapter property of your business host.• Add the business service or business operation to your production and provide values for anyruntime settings.In most cases, your custom code resides within your business host class. You do not typically need tocustomize the adapters directly.4 Using SQL Adapters with Ensemble