Flutter全能索引插件omniindex的使用

Flutter 全能索引插件 OmniIndex 的使用

OmniIndex/omniindex Dart 包

• 📒 OmniIndex Homomorphic Blockchain
• 🏫 Postgres Machine Learning
• 🏄‍♀️ 简单表面 API
• 🐦 在 LinkedIn 关注我们

预备条件

• flutter/dart 环境: 学习 Flutter

简介

OmniIndex Dart 包是一个库，用于处理 OmniIndex 客户端与其在 Flutter/Dart 应用程序环境中的相关数据之间的通信。

开始使用

安装

使用此包作为库

设置你的依赖项：

使用 Dart:

dart pub add omniindex

使用 Flutter:

flutter pub add omniindex

这将在你的 pubspec.yaml 文件中添加如下行（并运行隐式的 dart pub get）:

dependencies:
  omniindex:^1.0.0

或者，你的编辑器可能支持 dart pub get 或 flutter pub get。请查看你编辑器的文档以了解更多。

现在，在你的 Dart 代码中，你可以导入并使用该包:

import 'package:omniindex/omniindex.dart';

使用

1. 通过环境变量文件或其他安全来源提供详细信息来创建你的构造函数。切勿硬编码这些值。

   * [@param](/user/param) String apiServer (服务器地址)
   * [@param](/user/param) String seedNode (种子节点)
   * [@param](/user/param) String nodeServer (节点服务器)
   * [@param](/user/param) String localDomain (公司域)
   

2. 一旦你有了这些参数，你可以在你的 Flutter/Dart 项目中包含 OmniIndex 包：

   import 'package:omniindex/omniindex.dart';
   

3. 接下来，使用构造函数详细信息创建一个已连接的 OmniIndex 实例（oidx），并对其进行操作。

   示例：

   // 实例化默认值
   OmniIndex oidx = OmniIndex(debug: true);
   

   示例代码：

   /// fetchInfo 函数接受参数 [select] 和 [from] 以及一个 Map<String, String>[details] 来操作。
   Future<dynamic> fetchInfo(String select, String from, Map<String, String> details) async {
       dynamic jResponse = [];
   
       String query = "SELECT $select FROM .$from;";
   
       String body = jsonEncode(<String, dynamic>{
       "showEmptyFields": "false",
       "analyticQuery": query,
       //"showProtected": "true",
       "user": details["uid"],
       "unitName": details["email"]
       });
   
       // 接受默认构造函数。值是通过配置 JSON 文件建立的
       // 请参阅 README.md
       OmniIndex oidx = OmniIndex();
       String response = await oidx.callOmni('runanalyticqueryml', body, user);
   
       jResponse = jsonDecode(response);
       List<dynamic> res = jResponse['results'];
   
       return ((res.length == 0) ? 0 : ((select != '*') ? res.last[select] : jResponse['results']));
   }
   
   // 设置我们的详细信息
   Map<String, String> details;
   details['email'] = 'some@example.com';
   details['uid'] = 's123456789Id';
      
   // 获取高度数据并存储在我们的 details Map 中
   await fetchInfo('height', 'profile where height != 0',  details).then((height) => details['height'] = height);
   
   // 验证/操作来自 details['height'] 的高度
   

开发

API

• 最新 API 文档可以在 omniindex.pages.omniindex.io/packages/flutter/omniindex 查找

示例代码

/// 3-Clause BSD License
/// Copyright 2023 OmniIndex Inc.
///
/// Redistribution and use in source and binary forms, with or without
/// modification, are permitted provided that the following conditions are met:
///
/// 1. Redistributions of source code must retain the above copyright notice,
///    this list of conditions and the following disclaimer.
/// 2. Redistributions in binary form must reproduce the above copyright notice,
///    this list of conditions and the following disclaimer in the documentation
///    and/or other materials provided with the distribution.
/// 3. Neither the name of the copyright holder nor the names of its
///    contributors may be used to endorse or promote products derived from this
///    software without specific prior written permission.
///
/// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
/// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
/// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
/// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
/// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
/// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
/// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
/// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
/// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
/// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
/// POSSIBILITY OF SUCH DAMAGE.
///
/// [@author](/user/author): Ken Hawkins
/// [@email](/user/email): ken@omniindex.io
/// [@date](/user/date): 01/24/2023
/// [@project](/user/project): omniindex
///
/// 命名约定与 Google Dart 编程规范一致。
library omniindex.example;

import 'dart:convert';
import 'dart:io';

import 'package:logger/logger.dart';
import 'package:omniindex/omniindex.dart';

final _logger = Logger(
    printer: PrettyPrinter(
  methodCount: 0,
  errorMethodCount: 5,
  lineLength: 50,
  colors: true,
  printEmojis: true,
  printTime: true,
));

OmniIndex _getOmniIndexInstance() {
  PGBCCredentials pgbcCredentials = PGBCCredentials(
      username: '[Username]',
      password: '[Password]',
      dataSource: '',
      seed: '0.0.0.0',
      port: 5434);

  return OmniIndex.withPGBCCredentials(pgbcCredentials: pgbcCredentials);
}

Future<void> main() async {
  // omniindex (oidx) 对象进行操作
  OmniIndex oidx = _getOmniIndexInstance();

  if (!await oidx.authorize()) {
    _logger.e("could not log in");
    exit;
  }

  // 用户进行操作
  BasicCredentials testUser = BasicCredentials(
      username: 'test@omniindex.io', password: 'test@omniindex.io');

  // 添加用户
  String result = await oidx.addUser(testUser.username, testUser.password);

  // 解析响应
  Map<String, dynamic> json = jsonDecode(result) as Map<String, dynamic>;

  if (json.containsKey('error')) {
    _logger.e(json);
    _logger.e('exiting...');
    exit;
  }

  // 简单删除用户
  result = await oidx.deleteUser(testUser.username);

  json = jsonDecode(result) as Map<String, dynamic>;

  _logger.d(json);

  // 退出
  _logger.d('exiting...');

  exit;
}