NewLife.XCode 12.3.2026.1024-beta0636

NewLife.XCode - Data Middleware / Super ORM

🌐 简体中文 | 繁體中文 | Español | Deutsch | 日本語 | Français | Português | Русский | 한국어 | العربية

NewLife.XCode is a high-performance .NET data middleware focused on "CRUD + extreme performance + massive data". It includes multi-level caching, automatic modeling/migration, sharding, strongly-typed queries and cross-database migration. It supports MySQL / SQLite / SqlServer / Oracle / PostgreSQL / TDengine / InfluxDB / DaMeng / KingBase / HighGo / DB2 / ClickHouse / DuckDB / MongoDB / Hana (SAP HANA) / IRIS (InterSystems) / VastBase / Network virtual database / NovaDb / SonnetDB and more. Production deployments reach tens of billions of rows per table, and query throughput can reach billions of QPS (with caching strategies).

Docs: https://newlifex.com/xcode Community QQ groups: 1600800 / 1600838

Contents: Quick Start · Why XCode · Main Features · Ecosystem Map · Documentation · Contributing · Team · License

Quick Start

Install

NuGet reference (any project):

dotnet add package NewLife.XCode

Or use the template scaffold:

dotnet new install NewLife.Templates
dotnet new xcode --name Demo.Data
cd Demo.Data
dotnet build

The strong-name certificate is built in (newlife.snk); you can recompile for a private enterprise framework.

Define the model (db.xml)

<?xml version="1.0" encoding="utf-8"?>
<Tables Version="1.0" Output="MyEntity" NameSpace="Model" BaseClass="Entity" ConnName="DB">
  <Table Name="UserInfo" Description="User information">
    <Columns>
      <Column Name="Id" DataType="Int32" Identity="True" PrimaryKey="True" Description="Member id" />
      <Column Name="UserName" DataType="String" Nullable="False" Description="Member name" />
      <Column Name="Password" DataType="String" Nullable="False" Description="Member password" />
      <Column Name="Age" DataType="Int32" Description="Member age" />
    </Columns>
  </Table>
</Tables>

Generate entity classes

• Download xcodetool.exe into the directory and double-click it, or run: dotnet tool install xcodetool -g --prerelease → xcode db.xml.
• Generates: 用户信息.cs (data class, overwritten) + 用户信息.Biz.cs (business class, not overwritten).

CRUD

using XCode;

var user = new UserInfo { UserName = "Zhang San", Password = "123456", Age = 18 };
user.Insert();
Console.WriteLine("Inserted a new record, user id: " + user.Id);

var u2 = UserInfo.FindById(user.Id);
u2.Age = 19;
u2.Update();

var list = UserInfo.FindAll(UserInfo._.Age > 10 & UserInfo._.UserName == "Zhang San");
UserInfo.FindById(user.Id)?.Delete();

When using caches: fewer than 1000 entities → full-table cache; otherwise use regular queries / single-object cache.

Why XCode

• Homegrown and original: fully developed in China with no third-party components, self-controlled and backed by long-term maintenance.
• Simplicity: 90% of business scenarios need only single-table entity operations, with no hand-written SQL.
• Dapper compatible: executes arbitrary SQL queries and maps them to any entity model; fully compatible with Dapper usage while adding caching, read/write splitting and tracing.
• Extreme performance: multi-level caching on the core path + batch optimization + in-memory joins; query speed can be far higher than raw SQL.
• Massive data: native paging and sharding strategies; production projects reach tens of billions of rows per table; paging algorithms adapt to multiple databases.
• Stable and mature: 20+ years of evolution and broad production validation; keeps compatibility with older .NET Framework versions (from net45).
• Automatic migration: model/entity is the schema; new fields are synchronized automatically on deployment, with no extra SQL scripts.
• Distributed evolution: native table-level / time / primary-key sharding strategies for smooth splitting and scaling.
• Pluggable: DAL abstraction + separated providers; custom database adapters are supported.

Main Features

<details> <summary><b>Modeling & Code Generation</b> (5)</summary>

</details>

<details> <summary><b>Entity Runtime & DAL</b> (7)</summary>

</details>

<details> <summary><b>Query DSL</b> (8)</summary>

</details>

<details> <summary><b>Multi-level Cache System</b> (6)</summary>

Designed for read-heavy, write-light workloads:

</details>

<details> <summary><b>Reverse Engineering & Migration</b> (3)</summary>

</details>

<details> <summary><b>Sharding (ShardPolicy)</b> (3)</summary>

</details>

<details> <summary><b>Transactions & Cache Consistency</b> (3)</summary>

</details>

<details> <summary><b>Performance Optimizations</b> (6)</summary>

</details>

<details> <summary><b>Data Scope & Multi-Tenancy</b> (5)</summary>

</details>

<details> <summary><b>Multi-database Configuration</b> (4)</summary>

</details>

Usage examples

Dynamic conditions and paging

public static IList<UserInfo> Search(String name, Int32 age, Pager p)
{
    var exp = new WhereExpression();
    if (!name.IsNullOrEmpty()) exp &= UserInfo._.UserName == name;
    if (age > 0) exp &= UserInfo._.Age == age;
    return UserInfo.FindAll(exp, p);
}

Updating specified fields (bypasses cache; not recommended for regular use)

UserInfo.Update(UserInfo._.UserName == "Li Si" & UserInfo._.Age == 18, UserInfo._.Id == 1);

Custom sorting and column projection

var list = UserInfo.FindAll(UserInfo._.Age > 10, " Age DESC,Id ASC",
    string.Join(",", UserInfo._.UserName, UserInfo._.Age), 0, 20);

Indexes and generated methods

Add indexes to the model:

<Indexes>
  <Index Columns="UserName" Unique="True" />
  <Index Columns="UserName,Age" />
</Indexes>

After regeneration, FindByUserName, combined-condition helper methods / Search templates appear automatically.

Entity cache strategy: when Meta.Session.Count < 1000, use in-memory collection lookups; otherwise go to the database or single-object cache.

public static UserInfo FindByUserName(String userName)
{
    if (userName.IsNullOrEmpty()) return null;
    if (Meta.Session.Count < 1000) return Meta.Cache.Find(e => e.UserName.EqualIgnoreCase(userName));
    return Find(_.UserName == userName);
}

Sharding example

Meta.ShardPolicy = new TimeShardPolicy(nameof(UserInfo.Id), Meta.Factory)
{
    ConnPolicy = "{0}",           // customizable database name policy
    TablePolicy = "{0}_{1:yyyyMMdd}", // table name template
    Step = TimeSpan.FromDays(1)
};

All other code such as Insert / Query stays unchanged and is routed to the corresponding date table automatically.

Original examples (retained)

<details> <summary><b>Original CRUD and complex query examples</b></summary>

Create, read, update, delete

var user = new UserInfo();
user.UserName = "Zhang San";
user.Password = "123456";
user.Age = 18;
user.Insert();
Console.WriteLine("Inserted a new record, user id: " + user.Id);

var u = UserInfo.FindById(1);
u.UserName = "Zhang San";
u.Password = "123456";
u.Age = 19;
u.Update();

u = UserInfo.FindById(1);
Console.WriteLine($"User ID={u.Id} age updated to: {u.Age}");

Complex query

var list = UserInfo.FindAll(UserInfo._.UserName == "Zhang San" & UserInfo._.Age == 19, UserInfo._.UserName.Desc(), string.Join(",", UserInfo._.UserName, UserInfo._.Age), 0, 0);

</details>

Benchmarks

Actual performance depends on database type / hardware / sharding strategy / cache hit rate.

FAQ

• Why is the first Count fast? Meta.Count uses system indexes; SQLite may first take the identity maximum and then refine asynchronously.
• How soon is the cache consistent after an update? Writes in the current process are reflected immediately; across processes, wait for cache expiration or use an active invalidation strategy.
• Can automatic migration be disabled? Set Migration=Off (globally or per table), or use ReadOnly/On/Full as needed.
• Complex multi-table queries? Multiple single-table queries + in-memory association are recommended (faster with cache hits and clearer structure).

Ecosystem Map

NewLife is a layered ecosystem of independently versioned open-source projects. The map below is shared verbatim by every NewLife repository; each project links to its repository and its primary NuGet package.

Project	What it does	Downloads
Foundation
NewLife.Core	Logging, configuration, caching, networking, serialization, scheduling and APM tracing.
NewLife.XCode	Data middleware: single tables at the tens-of-billions scale, automatic sharding, read-write splitting, 10+ databases.
NewLife.Net	High-performance network library: 1.77M pps / 14.5 Gbps on a single machine (TCP 1KB, 2026-10), 4M long-lived TCP connections.
NewLife.Remoting	Protocol communication and RPC framework for client/server applications and IoT devices.
NewLife.Agent	Installs .NET applications as OS daemons: Windows services and Linux systemd.
NewLife.Templates	dotnet new project templates for console, web, API, service, data and IoT projects.
Data & Messaging
NewLife.Redis	Redis client with microsecond latency, millions of ops/s and built-in message queues.
NewLife.RocketMQ	Pure managed RocketMQ client for Apache RocketMQ and Alibaba Cloud Message Queue.
NewLife.MQTT	MQTT client and server, including Alibaba Cloud IoT connectivity.
NewLife.NovaDb	Hybrid database in C#: embedded or networked, relational, time-series, message queue and KV in one.
NewLife.MySql	MySql driver and helper layer built on the NewLife data stack.
Web, AI & Distributed
NewLife.Cube	Rapid admin-platform framework: permissions, SSO, OAuth server and CRUD scaffolding.
Stardust	Distributed service platform: node management, APM, configuration center, registry and release center.
AntJob	Distributed task and real-time data scheduling platform with sharding, retries and backfill.
NewLife.AI	Unified client for 46 LLM providers plus ChatAI, a ready-to-run web chat application.
Industrial & IoT
NewLife.IoT	IoT standard library defining protocol contracts and device abstractions.
NewLife.Modbus	Modbus TCP/RTU/ASCII implementation on top of NewLife.IoT.
NewLife.Siemens	Siemens PLC protocol on top of NewLife.IoT.
NewLife.Omron	Omron PLC protocol on top of NewLife.IoT.
NewLife.Melsec	Mitsubishi Melsec PLC protocol on top of NewLife.IoT.
NewLife.OPC	OPC client for industrial data access.	—
NewLife.BACnet	BACnet building-automation protocol stack.
ZeroIoT	Lightweight open-source IoT platform with gateway and device management.	—
Vehicle Telematics
NewLife.JT808	JT/T 808 vehicle positioning protocol: 70+ message bodies, 2011/2013/2019.
NewLife.JT809	JT/T 809 platform-to-platform protocol for transport authorities.
NewLife.JT1078	JT/T 1078 in-vehicle video: RTP parsing, FLV/fMP4 remuxing and live streaming.
Domain Components
NewLife.Office	One package for Excel, Word, PPT, PDF and 15+ document formats.
NewLife.Audio	Cross-platform audio: codecs, device I/O, DSP, containers and streaming.
NewLife.Video	Video codecs, container formats, frame processing and streaming.
NewLife.Map	Unified interface over Baidu, AMap, Tencent and Tianditu with geocoding and coordinate conversion.
NewLife.IP	IPv4 geolocation with an offline memory-mapped database and an online API fallback.
Tools & Products
CrazyCoder	Developer toolbox: network, serial port, crypto, regex, Modbus and MQTT.
GitCandy	Self-hosted Git source code management system.	—
LuckyClover	Installs the matching .NET runtime automatically when launched from an older host.	—

Badges show the primary package of each project; theme, extension and satellite packages are listed on their NuGet pages. The 30+ packages not listed here (FTP, LoRa, Office extensions, protocol drivers and more) are available under the NewLifeX organization and on newlifex.com. This table is maintained in the NewLife.Core README.

Documentation

• XCode documentation navigation: complete document index grouped by module
• XCode user manual: end-to-end usage walkthrough
• Architecture design: layering, components and key design decisions
• Multi-language localization: message model, language tables and runtime overrides
• Online documentation: https://newlifex.com/xcode
• ChangeLog.md: version history

Contributing

Build and test

dotnet restore
dotnet build -c Release
dotnet test XUnitTest.XCode -c Release

• Add cases under XUnitTest.XCode; performance-related suggestions should include benchmarks or explanations.
• Follow the repository conventions (strong naming, multi-TFM, XML comments, conditional compilation).
• Public API changes require a migration strategy (Obsolete → removal).

Release

Push a v-prefixed tag (for example v2026.1018) to trigger .github/workflows/publish.yml. The workflow packs XCode, XCodeTool and the provider packages (XCode.MySql, XCode.SQLite, XCode.SqlServer, XCode.Oracle, XCode.PostgreSQL, XCode.DaMeng, XCode.DB2, XCode.KingBase, XCode.HighGo) and pushes them to NuGet.org and GitHub Packages.

Feedback

• Issues / PRs are welcome: performance optimization / new database providers / documentation improvements.
• Before submitting, make sure dotnet build and the relevant unit tests pass; follow the repository conventions for code style and commit messages.
• Report bugs and suggestions via Issue; Stars and PRs are welcome.

Team

<img src="https://newlifex.com/logo.png" width="48" align="right" alt="NewLife" />

Founded in 2002, the NewLife team has spent more than two decades on the .NET and IoT ecosystem, maintains nearly 100 open-source projects (34 of them core to this map), and delivers integrated software and hardware solutions for power, logistics, healthcare, industrial control and internet industries. We live by the motto "learning has no seniority — mastery earns respect".

Open-source components have been downloaded 6.48M times from NuGet (ecosystem-wide, as of 2026-10).

Website: https://newlifex.com · Open source organization: https://github.com/NewLifeX

<details> <summary>WeChat Official Account: 智能大石头 (scan to follow)</summary>

</details>

License

MIT, fully open. Commercial use / modification / redistribution are allowed (you may replace "NewLife" with your enterprise brand for private deployments). The strong-name certificate newlife.snk is built in.

If this project helps you, please Star it, share it with your team, or send improvement suggestions via Issue/PR.