读取表结构详细信息 - GetTableInfoDetail

函数简介

读取指定表的详细结构信息，返回包含表详细结构信息的字符串指针。与 GetTableInfo 相比，此函数提供更详细的表结构信息，例如列的类型、长度、是否为主键、是否为外键等。

函数原型

long GetTableInfoDetail(long ola, const long db, string tableName);

参数定义

  • ola (长整型数): OLAPlug对象的指针，由 CreateCOLAPlugInterFace 接口生成。
  • db (长整型数): 数据库连接句柄，由 OpenDatabase 接口生成。
  • tableName (字符串): 表名称。

返回值

  • 返回值：包含表详细结构信息的字符串指针。如果操作失败，返回 0。

示例

SDK

C#
using System;
using OLA.ServiceCenter.PlugFactory;

namespace OLADemo
{
    internal class Program
    {
        static OLAPlugServer OLAServer;
        static void Main(string[] args)
        {
            OLAServer = new OLAPlugServer();
            var regResult = OLAServer.Reg(
                OLAServer.UserCode,
                OLAServer.SoftCode,
                OLAServer.FeatureList
            );
            OLAServer.CreateCOLAPlugInterFace();
            long db = OLAServer.OpenDatabase("OLAPlugDemo.db", "olaplug");
            Console.WriteLine($"OpenDatabase 返回:{db}");

            // 读取表详细结构信息
            string tableName = "MyTable";
            long tableInfoDetailPtr = OLAServer.GetTableInfoDetail(db, tableName);
            if (tableInfoDetailPtr != 0)
            {
                string tableInfoDetail = Marshal.PtrToStringAnsi(new IntPtr(tableInfoDetailPtr));
                Console.WriteLine($"表 {tableName} 的详细结构信息:");
                Console.WriteLine(tableInfoDetail);
            }
            else
            {
                Console.WriteLine($"读取表 {tableName} 的详细结构信息失败。");
            }
        }
    }
}

原生方式

Python
import os
import sys
from ctypes import *

# 1. 加载dll
# 此处路径为插件所在路径，请根据实际情况修改。
# 32位python使用x86版本，64位python使用x64版本
if sys.maxsize > 2**32:
    olaplug_dll = WinDLL(os.path.abspath(os.path.join(os.getcwd(), 'OLAPlug_x64.dll')))
else:
    olaplug_dll = WinDLL(os.path.abspath(os.path.join(os.getcwd(), 'OLAPlug_x86.dll')))

# 2. 注册到后台
UserCode = "c38e200f116d4fa8bd0deb45ccb523ea"
SoftCode = "701bc92ba84642c68845e7a06c10fd99"
FeatureList = "OLA|OLAPlus"
olaplug_dll.Reg.argtypes = [c_char_p, c_char_p, c_char_p]
olaplug_dll.Reg.restype = c_int32
result = olaplug_dll.Reg(UserCode.encode('utf-8'), SoftCode.encode('utf-8'), FeatureList.encode('utf-8'))
print(f'注册结果返回: {result}')

# 3. 创建ola对象
olaplug_dll.CreateCOLAPlugInterFace.restype = c_void_p
ola_obj = olaplug_dll.CreateCOLAPlugInterFace()

# 4. 打开数据库
olaplug_dll.OpenDatabase.argtypes = [c_void_p, c_char_p, c_char_p]
olaplug_dll.OpenDatabase.restype = c_void_p
db = olaplug_dll.OpenDatabase(ola_obj, "OLAPlugDemo.db".encode('utf-8'), "olaplug".encode('utf-8'))
print(f"openDatabaseResult={db}")

# 5. 读取表详细结构信息
tableName = "MyTable"
olaplug_dll.GetTableInfoDetail.argtypes = [c_void_p, c_void_p, c_char_p]
olaplug_dll.GetTableInfoDetail.restype = c_void_p
tableInfoDetailPtr = olaplug_dll.GetTableInfoDetail(ola_obj, db, tableName.encode('utf-8'))
if tableInfoDetailPtr != 0:
    tableInfoDetail = ctypes.cast(tableInfoDetailPtr, ctypes.c_char_p).value.decode('utf-8')
    print(f"表 {tableName} 的详细结构信息:")
    print(tableInfoDetail)
else:
    print(f"读取表 {tableName} 的详细结构信息失败。")

注意事项

  • 返回的表详细结构信息通常是一个字符串，可能包含列名、列类型、列长度、是否为主键、是否为外键、默认值等详细信息，具体格式取决于数据库的实现。
  • 如果表不存在或操作失败，函数将返回 0。
  • 使用完返回的字符串指针后，应妥善处理内存，避免内存泄漏。
Last Updated: