========================================
Microsoft SQL Server StreamInsight Samples
October 28, 2009
========================================

This Visual Studio Solution contains a set of console applications and class 
libraries that serve as sample applications, demonstrating various aspects of 
the StreamInsight SDK:

Console Applications:

  * ExplicitServer:     Demonstrates an end-to-end development experience using the 
                        StreamInsight object model API. Also shows how to access 
                        diagnostic views.

  * ImplicitServer:     Demonstrates a simplified development model.

  * Observable:         Demonstrates an alternative modeling of event producers and
                        Consumers.

  * PatternDetector:    Demonstrates the usage of the user-defined pattern
                        matching operator (ATN).

  * UserAggregateQuery: Demonstrates the usage of a user-defined aggregation.

  * SQLApp:             Demonstrates an end-to-end application interfacing SQL
                        Server on the input and output side.

Libraries:

  * SqlInputAdapter:       Reads rows from a SQL Server table as events.
 
  * TextFileInputAdapter:  Reads lines from a CSV file as events.
 
  * SqlOutputAdapter:      Writes events as rows into a SQL Server table.
 
  * TextFileOutputAdapter: Writes events as rows into a CSV file.
 
  * UserExtensions:        Contains a user-defined functionality that is used in 
                           the sample applications:
                             - User-defined function
                             - User defined aggregate
                             - Pattern matching operator


The console applications represent standalone CEP applications that build on 
top of the StreamInsight platform. They make use of the listed adapter 
assemblies.

We suggest going through the Applications in the above order and refering to the
respective README.txt in each project for further information. ImplicitServer is
set as startup project. To run a different application, right-click on the project
in the Solution Explorer and select "Set as StartUp Project".

----------------------------------------
Debugger
----------------------------------------

We recommend the ObjectModel sample project to become familiar with the 
StreamInsight Event Flow Debugger tool. To use the debugger, use the
following steps:

  1. Start an elevated command prompt and navigate to the folder "Debugger"
     inside the sample solution folder.

  2. Execute the command "trace.cmd start Sample.etl".

  3. Run the ObjectModel application.

  4. In the command prompt, execute "trace.cmd stop".

  5. Open the debugger (for example, through the Start Menu) and load the generated
     trace file "Sample.etl" from the "Debugger" folder.

The script "trace.cmd" is a copy of the script that is installed with 
StreamInsight into the tools/ folder of the installation location. It is 
contained in the sample package for convenient access.
