Product Documentation

c-treeDB API for C# - Developers Guide

Previous Topic

Next Topic

Quick Tour

FairCom provides four quick tutorials showing the major components of our core technology:

  • How to init, define, and manage data
  • How to handle index files
  • How to use locks in a multi-user environment
  • How to use transaction processing

To try these tutorials, see the tutorials in these ReadMe files:

You can find more tutorials in the ReadMe files for the c-treeDB navigational interface.

Navigational record-oriented interfaces:

Language

Notes

Drivers Folder

(V12 location)

Nickname

C

Record-oriented C API

c.nav

ctdb

C++

Record-oriented C++ API

cpp.nav

ctpp

C#

Record-oriented Microsoft C# .NET API

csharp.nav

 

Java

Record-oriented Java API

java.nav

jtdb

JPA Hibernate

Java

java.jpa.nav

ctree.isam.jpa

Node.js JavaScript - NAV

Record-oriented API for JavaScript

nodejs.nav

c-tree Node.js Module

Python FairCom NAV

Record-oriented API for Python

python.nav

Python NAV

Visual Basic

Record-oriented API for Microsoft Visual Basic .NET

vb.nav

vtdb

VCL

Record-oriented API for VCL data components for Embarcadero Delphi

(available from FairCom)

dtdb

You can find tutorials and information about the entire set of FairCom APIs in the following ReadMe:

The ReadMe files document the very basic tutorials packaged with the product. On the FairCom website you can find a highly informative interactive tutorial:

Online Interactive Tutorials

This tutorial covers the major programming languages that c-treeDB supports. It goes into depth to illustrate best practices for multi-threaded environments with SQL compatibility.

Run on supported versions of UNIX

The FairCom-provided assemblies can also be used on supported versions of the .NET runtime.

The required FairCom-provided assemblies are part of the FairCom bundles for the platforms where .NET is supported. The main assemblies are located in the <faircom>/drivers/ctree.drivers/lib folder. Look for FairCom.CtreeDb.dll and its variants where provided.

To run tutorials in the FairCom-provided assemblies under UNIX, run the makefile in the desired folder. You must first have .NET installed. See the following websites to know how to install .NET under supported UNIX platforms:

https://learn.microsoft.com/en-us/dotnet/core/install/linux

https://learn.microsoft.com/en-us/dotnet/core/install/macos

NOTE: Each tutorial has its own project file, such as:

<faircom>/drivers/csharp.nav/tutorials/cmdline/Tutorial1/Tutorials1.csproj

The tutorial projects are designed to work with dotnet 6.0 on Linux and MacOS, but will work with dotnet 7.0 and dotnet 8.0. To update to a later version of dotnet, locate the project file and change the following line to match the desired dotnet version:

<TargetFramework>net6.0</TargetFramework>

This applies to all the .csproj and vbproj files contained in the FairCom bundle, and applies to both C# and VB.

See:Target frameworks in SDK-style projects - .NET

Use without a makefile

It is possible to interact directly with the project folder, rather than use a makefile.

Go to the desired folder that contains the projects you want to work with and run the dotnet command.

[cmdline]$ cd <Faircom-folder>/drivers/csharp.nav/tutorials/cmdline

[cmdline]$ dotnet build Tutorial2

[cmdline]$ dotnet run Tutorial2

NOTE: The default tutorials are configured to run in client-server configuration. Make sure the server is started before running the tutorials.

See, https://learn.microsoft.com/it-it/dotnet/core/tools/

TOCIndex