Webql 1.0.0-prerelease.1

WebQL v3.0.0 - Language Documentation

Introduction

WebQL is a powerful query language designed to be compiled into LINQ expressions, allowing seamless integration with LINQ providers in C#. This documentation will guide you through the usage of WebQL, covering its syntax, semantics, operators, and providing comprehensive examples to get you started.

Table of Contents

// fix this markdown reference

1. Getting Started
2. Basic Syntax
3. Literals
4. Expressions
   1. Literal Expressions
   2. Reference Expressions
   3. Scope Access Expressions
   4. Block Expressions
5. Operators
   1. Arithmetic Operators
   2. Relational Operators
   3. Logical Operators
   4. String Relational Operators
   5. Collection Manipulation Operators
   6. Collection Aggregation Operators
6. Examples

Getting Started

Importing the Library

To start using WebQL in your project, you need to integrate the WebQL compiler. This compiler is available under the namespace Webql.

Import Statement

using Webql;

Using the Compiler

Basic Setup

Here is a simple example to get you started:

using Webql;

namespace MyProject;

public static void Program 
{
    public static void Main()
    {
        var compiler = new WebqlCompiler();
        //...
    }
}

Configuring the Compiler For more advanced usage, you can customize the compiler settings by providing an instance of WebqlCompilerSettings. This allows you to tailor the compiler behavior to suit your specific needs.

using Webql;

namespace MyProject;

public static void Program 
{
    public static void Main()
    {
        var settings = new WebqlCompilerSettings(
            // Configure your options here...
        );

        var compiler = new WebqlCompiler(settings);
        //...
    }
}

Compiling a Query

Once you have set up the compiler, you can start writing and compiling queries. Below is an example of how to compile a WebQL query into a LINQ Expression:

public static void Main(string[] args)
{
    var compiler = new WebqlCompiler();
    
    var query = "...";
    var elementType = typeof(...);

    var expression = compiler.Compile(query, elementType);

    //...
}

Writing Queries

Before you start writing queries its important to understand some key points about the language semantics. A WebQL query can be thought of as a function that takes a data collection and returns some result.

Example:

public TResult CreateQuery(IQueryable<TElement> source)
{
    ...
}