Componentpedia / Listings / ServiceStack.OrmLite

Last update: 20/12/2024

ServiceStack.OrmLite

Thoughtfully architected, obscenely fast, thoroughly enjoyable web services for all

Latest version: 8.5.2 registry icon
Maintenance score
100
Safety score
100
Popularity score
100
Check your open source dependency risks. Get immediate insight about security, stability and licensing risks.
De-risk your app now
Security
  Vulnerabilities
Version Suggest Low Medium High Critical
8.5.2 0 0 0 0 0
8.5.0 0 0 0 0 0
8.4.0 0 0 0 0 0
8.3.0 0 0 0 0 0
8.2.2 0 0 0 0 0
8.2.0 0 0 0 0 0
8.1.2 0 0 0 0 0
8.1.0 0 0 0 0 0
8.0.0 0 0 0 0 0
6.11.0 0 0 0 0 0
6.10.0 0 0 0 0 0
6.9.0 0 0 0 0 0
6.8.0 0 0 0 0 0
6.7.0 0 0 0 0 0
6.6.0 0 0 0 0 0
6.5.0 0 0 0 0 0
6.4.0 0 0 0 0 0
6.3.0 0 0 0 0 0
6.2.0 0 0 0 0 0
6.1.0 0 0 0 0 0
6.0.2 0 0 0 0 0
6.0.0 0 0 0 0 0
5.14.0 0 0 0 0 0
5.13.2 0 0 0 0 0
5.13.0 0 0 0 0 0
5.12.0 0 0 0 0 0
5.11.0 0 0 0 0 0
5.10.4 0 0 0 0 0
5.10.2 0 0 0 0 0
5.10.0 0 0 0 0 0
5.9.2 0 0 0 0 0
5.9.0 0 0 0 0 0
5.8.0 0 0 0 0 0
5.7.0 0 0 0 0 0
5.6.0 0 0 0 0 0
5.5.0 0 0 0 0 0
5.4.0 0 0 0 0 0
5.2.0 0 0 0 0 0
5.1.0 0 0 0 0 0
5.0.2 0 0 0 0 0
5.0.0 0 0 0 0 0
4.5.14 0 0 0 0 0
4.5.12 0 0 0 0 0
4.5.10 0 0 0 0 0
4.5.8 0 0 0 0 0
4.5.6 0 0 0 0 0
4.5.4 0 0 0 0 0
4.5.2 0 0 0 0 0
4.5.0 0 0 0 0 0
4.0.62 0 0 0 0 0
4.0.60 0 0 0 0 0
4.0.58 0 0 0 0 0
4.0.56 0 0 0 0 0
4.0.54 0 0 0 0 0
4.0.52 0 0 0 0 0
4.0.50 0 0 0 0 0
4.0.48 0 0 0 0 0
4.0.46 0 0 0 0 0
4.0.44 0 0 0 0 0
4.0.42 0 0 0 0 0
4.0.40 0 0 0 0 0
4.0.38 0 0 0 0 0
4.0.36 0 0 0 0 0
4.0.35 0 0 0 0 0
4.0.34 0 0 0 0 0
4.0.33 0 0 0 0 0
4.0.32 0 0 0 0 0
4.0.31 0 0 0 0 0
4.0.30 0 0 0 0 0
4.0.24 0 0 0 0 0
4.0.23 0 0 0 0 0
4.0.22 0 0 0 0 0
4.0.21 0 0 0 0 0
4.0.20 0 0 0 0 0
4.0.19 0 0 0 0 0
4.0.18 0 0 0 0 0
4.0.17 0 0 0 0 0
4.0.16 0 0 0 0 0
4.0.15 0 0 0 0 0
4.0.14 0 0 0 0 0
4.0.13 0 0 0 0 0
4.0.12 0 0 0 0 0
4.0.11 0 0 0 0 0
4.0.10 0 0 0 0 0
4.0.9 0 0 0 0 0
4.0.8 0 0 0 0 0
4.0.7 0 0 0 0 0
4.0.6 0 0 0 0 0
4.0.5 0 0 0 0 0
4.0.4 0 0 0 0 0
4.0.3 0 0 0 0 0

Stability
Latest release:

8.5.2 - This version is safe to use because it has no known security vulnerabilities at this time. Find out if your coding project uses this component and get notified of any reported security vulnerabilities with Meterian-X Open Source Security Platform

Licensing

Maintain your licence declarations and avoid unwanted licences to protect your IP the way you intended.

AGPL-3.0-only   -   GNU Affero General Public License v3.0 only

Not a wildcard

Not proprietary

OSI Compliant

Follow @ServiceStack or view the docs, use StackOverflow or the Customer Forums for support.

View the Release Notes for latest features or see servicestack.net/features for an overview.

Simple, Fast, Versatile and full-featured Services Framework

ServiceStack is a simple, fast, versatile and highly-productive full-featured Web and Web Services Framework that's thoughtfully-architected to reduce artificial complexity and promote remote services best-practices with a message-based design that allows for maximum re-use that can leverage an integrated Service Gateway for the creation of loosely-coupled Modularized Service Architectures. ServiceStack Services are consumable via an array of built-in fast data formats (inc. JSON, XML, CSV, JSV, ProtoBuf, Wire and MsgPack) as well as XSD/WSDL for SOAP endpoints and Rabbit MQ, Redis MQ and Amazon SQS MQ hosts.

Its design and simplicity focus offers an unparalleled suite of productivity features that can be declaratively enabled without code, from creating fully queryable Web API's with just a single Typed Request DTO with Auto Query supporting every major RDBMS to the built-in support for Auto Batched Requests or effortlessly enabling rich HTTP Caching and Encrypted Messaging for all your existing services via Plugins.

Your same Services also serve as the Controller in ServiceStack's Smart Razor Views reducing the effort to serve both Web and Single Page Apps as well as Rich Desktop and Mobile Clients that are able to deliver instant interactive experiences using ServiceStack's real-time Server Events.

ServiceStack Services also maximize productivity for consumers providing an instant end-to-end typed API without code-gen enabling the most productive development experience for developing .NET to .NET Web Services.

Generate Instant Typed APIs from within all Major IDEs!

ServiceStack now integrates with all Major IDE's used for creating the best native experiences on the most popular platforms to enable a highly productive dev workflow for consuming Web Services, making ServiceStack the ideal back-end choice for powering rich, native iPhone and iPad Apps on iOS with Swift, Mobile and Tablet Apps on the Android platform with Java, OSX Desktop Applications as well as targeting the most popular .NET PCL platforms including Xamarin.iOS, Xamarin.Android, Windows Store, WPF, WinForms and Silverlight:

VS.NET integration with ServiceStackVS

Providing instant Native Typed API's for C#, TypeScript, F# and VB.NET directly in Visual Studio for the most popular .NET platforms including iOS and Android using Xamarin.iOS and Xamarin.Android on Windows.

Xamarin Studio integration with ServiceStackXS

Providing C# Native Types support for developing iOS and Android mobile Apps using Xamarin.iOS and Xamarin.Android with Xamarin Studio on OSX. The ServiceStackXS plugin also provides a rich web service development experience developing Client applications with Mono Develop on Linux

Xcode integration with ServiceStackXC Plugin

Providing an instant Native Typed API in Swift including generic Service Clients enabling a highly-productive workflow and effortless consumption of Web Services from native iOS and OSX Applications - directly from within Xcode!

Android Studio integration with ServiceStackIDEA

Providing an instant Native Typed API in Java and Kotlin including idiomatic Java Generic Service Clients supporting Sync and Async Requests by leveraging Android's AsyncTasks to enable the creation of services-rich and responsive native Java or Kotlin Mobile Apps on the Android platform - directly from within Android Studio!

IntelliJ integration with ServiceStackIDEA

The ServiceStack IDEA plugin is installable directly from IntelliJ's Plugin repository and enables seamless integration with IntelliJ Java Maven projects for generating a Typed API to quickly and effortlessly consume remote ServiceStack Web Services from pure cross-platform Java or Kotlin Clients.

Eclipse integration with ServiceStackEclipse

The unmatched productivity offered by Java Add ServiceStack Reference is also available in the ServiceStackEclipse IDE Plugin that's installable from the Eclipse MarketPlace to provide deep integration of Add ServiceStack Reference with Eclipse Java Maven Projects enabling Java Developers to effortlessly Add and Update the references of their evolving remote ServiceStack Web Services.

servicestack-cli - Simple command-line utilities for ServiceStack

In addition to our growing list of supported IDE's, the servicestack-cli cross-platform command-line npm scripts makes it easy for build servers, automated tasks and command-line runners of your favorite text editors to easily Add and Update ServiceStack References!

Simple Customer Database REST Services Example

This example is also available as a stand-alone integration test:

//Web Service Host Configuration
public class AppHost : AppSelfHostBase
{
    public AppHost() 
        : base("Customer REST Example", typeof(CustomerService).Assembly) {}

    public override void Configure(Container container)
    {
        //Register which RDBMS provider to use
        container.Register<IDbConnectionFactory>(c => 
            new OrmLiteConnectionFactory(":memory:", SqliteDialect.Provider));

        using (var db = container.Resolve<IDbConnectionFactory>().Open())
        {
            //Create the Customer POCO table if it doesn't already exist
            db.CreateTableIfNotExists<Customer>();
        }
    }
}

//Web Service DTO's
[Route("/customers", "GET")]
public class GetCustomers : IReturn<GetCustomersResponse> {}

public class GetCustomersResponse
{
    public List<Customer> Results { get; set; } 
}

[Route("/customers/{Id}", "GET")]
public class GetCustomer : IReturn<Customer>
{
    public int Id { get; set; }
}

[Route("/customers", "POST")]
public class CreateCustomer : IReturn<Customer>
{
    public string Name { get; set; }
}

[Route("/customers/{Id}", "PUT")]
public class UpdateCustomer : IReturn<Customer>
{
    public int Id { get; set; }

    public string Name { get; set; }
}

[Route("/customers/{Id}", "DELETE")]
public class DeleteCustomer : IReturnVoid
{
    public int Id { get; set; }
}

// POCO DB Model
public class Customer
{
    [AutoIncrement]
    public int Id { get; set; }

    public string Name { get; set; }
}

//Web Services Implementation
public class CustomerService : Service
{
    public object Get(GetCustomers request)
    {
        return new GetCustomersResponse { Results = Db.Select<Customer>() };
    }

    public object Get(GetCustomer request)
    {
        return Db.SingleById<Customer>(request.Id);
    }

    public object Post(CreateCustomer request)
    {
        var customer = new Customer { Name = request.Name };
        Db.Save(customer);
        return customer;
    }

    public object Put(UpdateCustomer request)
    {
        var customer = Db.SingleById<Customer>(request.Id);
        if (customer == null)
            throw HttpError.NotFound("Customer '{0}' does not exist".Fmt(request.Id));

        customer.Name = request.Name;
        Db.Update(customer);

        return customer;
    }

    public void Delete(DeleteCustomer request)
    {
        Db.DeleteById<Customer>(request.Id);
    }
}

Calling the above REST Service from any C#/.NET Client

No code-gen required, can re-use above Server DTOs:

var client = new JsonServiceClient(BaseUri);

//GET /customers
var all = client.Get(new GetCustomers());                         // Count = 0

//POST /customers
var customer = client.Post(new CreateCustomer { Name = "Foo" });

//GET /customer/1
customer = client.Get(new GetCustomer { Id = customer.Id });      // Name = Foo

//GET /customers
all = client.Get(new GetCustomers());                             // Count = 1

//PUT /customers/1
customer = client.Put(
    new UpdateCustomer { Id = customer.Id, Name = "Bar" });       // Name = Bar

//DELETE /customers/1
client.Delete(new DeleteCustomer { Id = customer.Id });

//GET /customers
all = client.Get(new GetCustomers());                             // Count = 0

Same code also works with Android, iOS, Xamarin.Forms, UWP and WPF clients.

F# and VB.NET can re-use same .NET Service Clients and DTO's

Calling from TypeScript

const client = new JsonServiceClient(baseUrl);
const { results } = await client.get(new GetCustomers());

Calling from Swift

let client = JsonServiceClient(baseUrl: BaseUri)

client.getAsync(GetCustomers())
    .then {
        let results = $0.results;
    }

Calling from Java

JsonServiceClient client = new JsonServiceClient(BaseUri);

GetCustomersResponse response = client.get(new GetCustomers());
List<Customer> results = response.results;

Calling from Kotlin

val client = JsonServiceClient(BaseUri)

val response = client.get(GetCustomers())
val results = response.results

Calling from Dart

var client = new JsonServiceClient(BaseUri);

var response = await client.get(GetCustomers());
var results = client.results;

Calling from jQuery using TypeScript Definitions

$.getJSON($.ss.createUrl("/customers", request), request, (r: GetCustomersResponse) => {
    var results = r.results;
});

Using TypeScript Definitions with Angular HTTP Client:

this.http.get<GetCustomersResponse>(createUrl('/customers', request)).subscribe(r => {
    this.results = r.results;
});

Calling from jQuery

$.getJSON(baseUri + "/customers", function(r) {
	var results = r.results;
});

That's all the application code required to create and consume a simple database-enabled REST Web Service!

Getting Started

Release Notes

Download

If you have NuGet installed, the easiest way to get started is to:

Install ServiceStack via NuGet.

Latest v4+ on NuGet is a commercial release with free quotas.

Docs and Downloads for older v3 BSD releases

Live Demos

The Definitive list of Example Projects, Use-Cases, Demos, Starter Templates

Copying

Since September 2013, ServiceStack source code is available under GNU Affero General Public License/FOSS License Exception, see license.txt in the source. Alternative commercial licensing is also available, see https://servicestack.net/pricing for details.

Contributing

Contributors need to approve the Contributor License Agreement before any code will be reviewed, see the Contributing docs for more details. All contributions must include tests verifying the desired behavior.

OSS Libraries used

ServiceStack includes source code of the great libraries below for some of its core functionality. Each library is released under its respective licence:

Find out More

Follow @ServiceStack and +ServiceStack for project updates.

Core Team

Contributors

A big thanks to GitHub and all of ServiceStack's contributors:

Similar open source projects

Similar Open source .NET projects for developing or accessing web services include:

  • Nancy Fx - A Sinatra-inspired lightweight Web Framework for .NET:
  • Fubu MVC - A "Front Controller" pattern-style MVC framework designed for use in web applications built on ASP.NET:
  • Rest Sharp - An open source REST client for .NET