Package: laiye-dataservice-sdk
这是来也数据服务对应的SDK。Initialize a client ｜ 初始化客户端fromlaiye_dataserviceimportDataService,AuthorizationType,DSResultclient=DataService("https://cloud.laiye.com/dataservice",'BuiltInUser',username="this is username",password="this is password",api_key=None,timeout_seconds=30,language='en')result:DSResult=client.get_schema("schema_name")print(result.get_data())print(result.get_code())print(result.get_message())Authorization | 权限相关logout退出登录logout()示例result:DSResult=client.logout()Metadata Management | 元信息维护create_schema添加数据表create_schema(self, schema_api_name, display_name, description='') -> DSResultschema_api_name: 数据表名称display_name: 数据表显示名称description: 描述信息，默认为空字符串示例result:DSResult=self.ds.create_schema("test_01","Test 01","")delete_schema删除数据表delete_schema(self, schema_api_name, expansion_level=2) -> DSResultschema_api_name: 数据表名称expansion_level: 数据展开层级，默认为2get_schemas获取数据表列表get_schemas(self, start_id=0, limit=1000, order='asc', expansion_level=2) -> DSResultstart_id: 开始记录ID，默认值0。limit: 返回的最多记录数，默认值1000。order: 排序方式，默认为 'asc'， 也可以选择 'desc'expansion_level: 数据展开层级，默认为2get_schema获取数据表详情get_schema(self, schema_api_name, expansion_level=2) -> DSResultschema_api_name: 数据表名称expansion_level: 数据展开层级，默认为2add_fields添加字段-批量add_fields(self, schema_api_name, fields, expansion_level=2) -> DSResultschema_api_name: 数据表名称fields: 字段数据，是一个字典数组[{"apiName":"","displayName":"","description":"","dataMaxLength":0,"dataMaxValue":0,"dataMinLength":0,"dataMinValue":0,"defaultValue":"","fieldType":"",# 字段类型,可用值:BOOLEAN,DATE,DATETIME,DOUBLE,FILE,HTML,IMAGE,JSON,LONG,MARKDOWN,RELATIONSHIP,TEXT,TIME"orderNum":0,"pointLength":0,"referenceDisplayFieldApiName":"","referenceJoinFieldApiName":"","referenceSchemaApiName":"","allowNull":false,}]expansion_level: 数据展开层级，默认为2delete_fields删除字段-批量delete_fields(self, schema_api_name, field_api_names, expansion_level=2) -> DSResult:schema_api_name: 数据表名称field_api_names: 字段名称列表expansion_level: 数据展开层级，默认为2add_index添加索引add_index(self, schema_api_name, index, expansion_level=2) -> DSResultschema_api_name: 数据表名称index: 要增加的索引描述{"apiName":"","description":"","displayName":"","fieldApiNames":['field1','field2'],"type":"UNIQUE"# 索引类型,可用值:GENERAL,UNIQUE}expansion_level: 数据展开层级，默认为2get_index获取单个索引信息get_index(self, schema_api_name, index_api_name, expansion_level=2) -> DSResultschema_api_name: 数据表名称index_api_name: 索引名称expansion_level: 数据展开层级，默认为2Data Management | 数据管理add_records新增实体(记录)add_record(self, schema_api_name, record, update_or_insert=False, response_with_data=False) -> DSResultschema_api_name: 数据表名称record: 数据记录，是一个字典{"name":"Tom","age":20}update_or_insert: 如果数据存在是否将其替换，默认为 False。这个能力需要在数据表上先创建唯一索引。add_records新增实体(记录)-批量add_records(self, schema_api_name, records, update_or_insert=False, response_with_data=False) -> DSResultschema_api_name: 数据表名称records: 数据记录，是一个字典数组[{"name":"Tom","age":20},{"name":"Jack","length":180}]update_or_insert: 如果数据存在是否将其替换，默认为 False。这个能力需要在数据表上先创建唯一索引。delete_records删除实体(记录)-批量def delete_records(self, schema_api_name, record_ids, response_with_data=False) -> DSResult:schema_api_name: 数据表名称record_ids: 记录ID列表response_with_data: 是否将操作的数据返回，默认为False。delete_record删除实体(记录)delete_record(self, schema_api_name, record_id, response_with_data=False) -> DSResult:schema_api_name: 数据表名称record_id: 记录IDresponse_with_data: 是否将操作的数据返回，默认为False。search_records查询实体(记录)列表-支持组合查询条件和组合排序条件search_records(self, schema_api_name, search_data) -> DSResult:schema_api_name: 数据表名称search_data: 查询消息体get_records获取实体(记录)列表get_records(self, schema_api_name, start_id=0, limit=1000, order='asc') -> DSResultschema_api_name: 数据表名称start_id: 开始记录ID，默认值0。limit: 返回的最多记录数，默认值1000。order: 排序方式，默认为 'asc'， 也可以选择 'desc'update_records更新实体(记录)-批量update_records(self, schema_api_name, records, response_with_data=False) -> DSResult:schema_api_name: 数据表名称records: 要修改的记录列表，一个字典列表。response_with_data: 是否将操作的数据返回，默认为False。update_record更新实体(记录)update_record(self, schema_api_name, record_id, record, response_with_data=False) -> DSResult:schema_api_name: 数据表名称record_id: 记录IDrecord: 要修改的记录，一个字典。response_with_data: 是否将操作的数据返回，默认为False。exec_select_sqlSQL执行exec_select_sql(self, select_sql) -> DSResult:select_sql: SQL语句，字符串类型。分析数据获取get_queriesget_queries(self, page=1, page_size=20, order='created_at') -> DSResult:get_queryget_query(self, query_id) -> DSResult:exec_queryexec_query(self, query_id, params={}) -> DSResult:get_job_statusget_job_status(self, job_id) -> DSResult:get_cached_query_resultget_cached_query_result(self, query_id, result_id) -> DSResult:get_query_resultget_query_result(self, query_id, params={}, if_refresh=False, time_seconds=30) -> DSResult: