EBBuildClient 1.0.102

BuildDB® API Client

The Official API Client for Blockchain-based Cloud Storage Services!

Features

If your application requires cloud storage of unstructured JSON or key/value paired data, the EB Build client is an affordable and extremely fast alternative to any of the following solutions:

• ✨ AWS DynamoDB
• ✨ Azure CosmoDB
• ✨ Google Cloud Datastore
• ✨ Oracle NoSQL Database
• ✨ PostgreSQL
• ✨ MongoDB
• ✨ RavenDB
• ✨ Redis Couchbase

Benefits

• ✨ xtremely affordable flexible fee pricing based on database size!
• ✨ xtremely secure blockchain encryption!
• ✨ xtremely fast event messaging!
• ✨ xtremely powerful distributed denial of service (DDoS) features!
• ✨ xtremely scalable with built-in cluster-wide auto-scaling!
• ✨ xtremely powerful AI-based fuzzy matching for powerful filtering!
• ✨ xtremely powerful lazy loading of parent child relationship without indexes!
• ✨ xtremely simple integration with dynamic environments!
• ✨ xtremely powerful integration that combines NoSQL, relational and vector databases!

Obtaining a Sandbox API Key

EBBuild cloud services can be accessed via our sandbox for a limited time. The EBBuild Client requires an API key before using the sandbox. Obtaining a sandbox API key is extremely easy! Follow the next steps to obtain an API key.

• ** Send an email with your company name to: keyrequest@everythingblockchain.io**

Pre-Installation Steps:

#1. Click Here to Create a Private Cluster

#2. Click Here to Download the EBBuild Client via nuget

#3. Add the following dependencies to your project:

   3.1 Microsoft.AspNetCore.SignalR.Client version 7.0.2 (or higher)
   3.2 Microsoft.AspNetCore.SignalR.Protocols.MessagePack version 7.0.2 (or higher)

Post-Installation Steps:

#1 After creating a private cluster you will receive an automated email with the following:
    #1.1 A link to your private cluster in the cloud.
    #1.2 A security token required to store and retrieve data.
#2 Install the BuildDB Client nuget package into your Microsoft Visual Studio project.
#2 Add an appsettings.json file to project, if you don't already have an appsettings.json file added.
#3 Add the following values to the root of your appsettings.json file added to your project:
  {
     "BuildDBApiBaseUri": [enter the url provided by EBI, INc],
     "BuildDBApiToken": [enter the API key obtained supplied to you.],
     "BuildDBApiRoles": [enter user groups here.  
				For example you could enter: "Testers"],
     "BuildDBRegistrationHost": [enter the name of company or entity: 
					"Company ABC, Inc"]
   }

How To's

#1 After installing the BuildDBClient nuget package, add the following to your code:
      using BuildDBClient.Core;
      
#2 BuildDB allows you to store json data without any class/object or a concrete class/object.  For example, if you have the following defined data type and if you wanted to store its data onto the BuildDB cloud storage services, you would following for following example.  ALL classes passed in MUST implement the "CommonInterfaces" interface.  The "CommonInterfaces" interface ensure that all classes can support parent child relationships and aggregate function data.

    public class SampleDataClass: CommonInterfaces
    {
        public string ID {get; set;}
        public string Name {get; set;}
        public AddressClass Address1 {get; set;}
    }
    public class AddressClass: CommonInterfaces
    {
        public string City {get; set;}
        public string State {get; set;}
        public string Zip {get; set;}
    }       
    
#3 The BuildDB cloud services support both REST and Websocket endpoints.  Addtionally, the BuildDB client allows you to connect with using REST or a Websocket.

#4 Initialize the core BuildDB services in the following manner:
    #4.1 BuildDBApiFactory : This class is the core object used to manage connection objects.
         BuildDBApiFactory _BuildDBDBApiServiceFactory = 
	  new BuildDBApiFactory(
		_maxConnections, 
		Program._configuation, 
		_BuildDBDBUserEmail, 
		_BuildDBDBTenantId, 
		_BuildDBDBLedgerPreface, 
		_BuildDBDBLedgerName, 
		_BuildDBDBApiBaseUri, 
		_maxRecordsReturned, 
		_BuildDBDBUseWebSockets);
    
    #4.2 IBuildDBAPIService: This interface is used for all connection 
         object created by the BuildDBApiFactory.
         IBuildDBAPIService _client1 = 
		_BuildDBDBApiServiceFactory.GetApiClient();
         
    #4.3 BuildDBAPIService: This is a static class used to calling all CRUD 
	methods.
         List<string> recordList = BuildDBAPIService.GetLedgerRecords<string>(_filters, _client1).Result;
         List<string> recordList = BuildDBAPIService.GetLedgerRecords<string>(_filters, _BuildDBDBApiServiceFactory.GetApiClient()).Result;
         List<SampleDataClass> recordList = BuildDBAPIService.GetLedgerRecords<SampleDataClass>(_filters, _BuildDBDBApiServiceFactory.GetApiClient()).Result;

Filters

#5 The EBBuild cloud services support query filters used to filter data objects.
#6 To simplify creating filter conditions, the EBBuild client provides a filter builder.
    #6.1 List<string> _filters = EBIBuildAPIHelper.BuildFilter(_filters, "email", FilterOperation.EQ, "dummyuser15@gmail.com");
    #6.2 List<string> _filters = EBIBuildAPIHelper.BuildFilter(_filters, "email", FilterOperation.EQ, "dummyuser15@gmail.com", BooleanOperation.AND);

Aggregate Filter Functions

#7 The EBBuild cloud services support aggregate functions used to obtain group counts and sorting on data objects.
#8 To simiplify creating aggregate functions, the EBBuild client provides a function builder.
    #8.1 List<string> _filters = EBIBuildAPIHelper.BuildFilterFunction(_filterFunctions, new List<string>() { "Gender", "Age" }, FilterFunctionOperation.GROUPBY);
    #8.2 List<string> _filters = EBIBuildAPIHelper.BuildFilterFunction(_filterFunctions, new List<string>() { "LastName" }, FilterFunctionOperation.ORDERBY_DESC);
    
NOTE: In-order to see the group count value, you must include into your DTO a field named "GroupCount".
      The results (when groupBy is used) will only include values for the fields in the groupby clause and the GroupCount field.
      
NOTE: If you require raw data, then use our internal RawDataType class type.

NOTE: The RawDataType class has a single property called "RawData" or simply use the "String" data type which will contain your unstructured json payload.
    RawDataType rawData = await EBBuildAPIService.GetLedgerRecord<RawDataType>(EBBuildAPIServices);
    string rawData = await EBBuildAPIService.GetLedgerRecord<string>(EBBuildAPIServices);

   
Set the following required parameters.
     Microsoft.Extensions.Configuration.IConfiguration configuration;
     string email = "a valid email address";
     string tenantID = "any unique string to identify your organization";
     string ledgerPreface = "any string to identify your ledger.  i.e.: prod, qa, dev, crypto, etc.";
     string ledgerName = "any name of your ledger where your data class will be stored.  i.e. payments";

NOTE: If you do not specify a ledgername then the email address will automatically be used as the ledger name.
      If you specify a ledgerPreface then the ledgerPreface will be prepended to the ledger name.
      

#7. To enforce multi-factor authentication (MFA) you can set the enableMFA parameter.
     NOTE: When saving data to the ledger, if you set the MFA parameter to "true" and if suspicious read access to the ledger is detected that read access will be block temporarily until an email challenge is sent to you (the owner of the ledger to allow you an opportunity to block or allow access).
     
     bool enableMFA = true;   
     string blockTypeName = "SampleDataClass";
   
   - EBBuildAPIService.SaveDataToLedger(
      dataContext,
      EBBuildAPIServices,
      enableMFS,
      blockTypeName);

Basic CRUD Functions

Adding Filter Conditions

Adding Parent Child Relationships

SchemaRelationshipDef _schemaDefinition = new SchemaRelationshipDef() {             RelationshipName = "RecentSearches2Children",             Relationships = new List<SchemaRelationshipDetails>()             {                  new SchemaRelationshipDetails()                  {
                         TargetSchemaName = typeof(Search_Child).AssemblyQualifiedName.Substring(0,typeof(Search_Child).AssemblyQualifiedName.IndexOf(",")),                          TargetSchemaType = typeof(Recent_Searche_Child),                          Relationship = new SchemaRelationship()                          {                                     SourceSchemaKey = "PK",                                      TargetSchemaKey = "ParentPK",                                      Filters= _childFilters,                                      FilterFunctions = _childFilterFunctions
                         },                          ChildRelationship = null                 }             }   };

Distributed Denial of Service (DDoS) Features - Documentation

Once you have data stored securely within BuildDB, you need to ensure users can access it. Combating DDoS requires capabilities that firewalls don't possess.

• ✨ Firewalls have no intelligence on what business transaction is being performed. Thus you cannot implement brute force check against transactions. It is either URL or IP.
• ✨ If a firewall has to implement brute force attack detection, it has to read the whole payload and then inspect for patterns. This requires high CPU Á Memory usage on Firewall. In case of https, it requires you to terminate https at firewall level so that it can read the received data.
• ✨ Most firewalls have basic scripting language to configure rules. Some do support JavaScript like language, but check the CPU cost of that and the price tag. With HackerSpray, you get .NET code, so the sky is the limit.
• ✨ Firewalls have limited storage for logs and shipping logs from firewall to analysis engines puts stress on the firewall, especially when you are under attack. Many a times, we experience Firewall CPU exhaustion when it is blocking DOS, while it is writing all those attacks in a log and also shipping the logs to our analysis servers.

The answer is more business level intelligent to analyze data before it is added to storage. The solution is BuildDB! Before storing data into BuildDB, simply invoke the following command "GetDDoSStatisticsAync" to instandly gather metrics on the frequency of records written using the same filterKey to allow or block adding additional records initiated by bad actors. It's that easy to implement DDoS!

 (List<ClassTypeX> DoSRecordList, paginationDetails) = EBBuildAPIService.GetDDoSStatisticsAsync<ClassTypeX>(
              asyncWrapper: _ebBuildDBApiServiceFactory.GetAsyncWrapper(),
              filterKey: "Id_Field", 
              filterKeyValue: "cac5bf97-2acc-461c-b4dd-c962bd45f996",
              DateTimeKey: "Time_Stamp_Field",
              timeInterval: DoSTimeInterval.ELAPSEDMINUTES,
              DDoSTimeIntervalValue: "1",
              servicContext: _client1,
              EnforceCacheResults: false,
              StringNameOfType: typeof(ClassTypeX).Name).Result;

Regular Expression - Documentation

Company Contact Information

License

MIT- The API is and will always remain free! The data storage is based on a fixed fee. Contact EverythingBlockchain, Inc for details.