GearAPI version1.0
DocGearAPI
Public Member Functions | Properties | List of all members
1.DataServiceEx Class Reference

Public Member Functions

def __init__ (self, is_macro_stop=False, is_language="ja-JP")
 
def output_log (self, is_content='No', is_result='Yes', is_recipe='No', is_document='No')
 
def add_realitem (self, table_name, add_position, new_item_name, item_type, file_name)
 
def append_row (self, table_name, row_count, start_row=1)
 
def calc (self, table_name, item_name, calc_string, row_count=-1, start_row=1, setid=-1)
 
def catalog (self, table_name, file_name, catalog_name, mode=None)
 
def read_csv (self, table_name, file_name)
 
def categorize (self, table_name, item_name, category_table_name)
 
def clear_ws (self)
 
def comment (self, comment)
 
def edit_comma (self, table_name, item_name, is_edit='Yes')
 
def compression (self, table_name)
 
def join (self, table_name, master_table_name, slave_table_name, master_setid, slave_setid, master_join_key, slave_join_key, is_in_out, is_transfer_item='No')
 
def create_table (self, row_count, table_name)
 
def db_codeset (self, db_codeset)
 
def db_load (self, file_name)
 
def db_save (self, file_name)
 
def delete_allset (self, table_name)
 
def delete_resultset (self, table_name, setid)
 
def delete_row (self, table_name, start_row, row_count, setid=-1)
 
def delete_item (self, table_name, item_name)
 
def delete_table (self, table_name)
 
def duplicate_table (self, table_name)
 
def duplicate_item (self, table_name, item_name)
 
def extract_set (self, table_name, setid, is_view_table_id='Yes', is_record_number='Yes', item_name_list=' *', new_table_name=None)
 
def extract_unique (self, table_name, setid, item_name_list=' *', is_keep_order='Yes')
 
def fill_cell (self, table_name, item_name, set_string, start_row=1, row_count=-1, setid=-1)
 
def sort_item (self, table_name, sort_key)
 
def transfer_item (self, table_name, item_name)
 
def float_format (self, table_name, item_name, digit)
 
def get_cell (self, table_name, item_name, start_row=1, row_count=1, setid=-1)
 
def get_tuple_asjson (self, table_name, start_row=1, fetch_size=128, setid=-1)
 
def get_tuple (self, table_name, start_row=1, fetch_size=128, setid=-1)
 
def get_itemlist (self, table_name)
 
def get_license_expiration (self)
 
def get_limit_cpu (self)
 
def get_memory (self, table_name)
 
def get_limit_memory (self)
 
def get_limit_row (self)
 
def get_setid_list (self, table_name)
 
def get_rowcount (self, table_name, setid=-1)
 
def get_tablelist (self)
 
def get_tablename (self, tableid)
 
def get_valuelist (self, table_name, setid, item_name)
 
def get_version (self)
 
def join_inout (self, table_name, is_slave, is_in_out)
 
def insert_row (self, table_name, row_count, start_row=1)
 
def join_realize (self, join_table_name, real_table_name, setid, master_rec_number='Yes', slave_rec_number='Yes', item_name_list=' *')
 
def load (self, file_name)
 
def move_item (self, table_name, item_name_list, item_name)
 
def overwrite (self, table_name, item_name, start_row, row_count, fill_string_list, is_ex_space='No', setid=-1)
 
def overwrite_batch (self, table_name, start_row, row_count, fill_string_list, setid=-1)
 
def rename_table (self, table_name, new_table_name)
 
def rename_item (self, table_name, item_name, new_item_name)
 
def save (self, file_name)
 
def search (self, table_name, item_name, setid, search_string)
 
def search_values (self, table_name, item_name, setid, search_string_list)
 
def search_values_bycsv (self, table_name, item_name, setid, file_name)
 
def search_values_bytable (self, table_name, item_name, setid, list_table_name, list_item_name, list_setid)
 
def search_string (self, table_name, setid, expression)
 
def setand (self, table_name, src_setid, dst_setid)
 
def set_cell (self, table_name, item_name, start_row, row_count, fill_string_list, setid=-1)
 
def set_comment (self, table_name, setid, comment_string)
 
def move_currentset (self, table_name, setid)
 
def delete_set (self, table_name, setid)
 
def setnot (self, table_name, setid)
 
def setor (self, table_name, src_setid, dst_setid)
 
def set_license (self, license_key)
 
def setsub (self, table_name, src_setid, dst_setid)
 
def sort (self, table_name, item_name, setid, sort_type='ASC')
 
def write_csv (self, table_name, file_name, setid, delimiter='CSV', write_top=1, write_bottom=-1, write_left=1, write_right=-1, is_header='Yes')
 
def write_csv_selectitem (self, table_name, file_name, setid, delimiter='CSV', write_top=1, write_bottom=-1, item_name_list=' *', is_header='Yes')
 
def convert_type (self, table_name, item_name, data_type)
 
def union (self, table_name, master_table_name, slave_table_name, master_setid, slave_setid, master_union_key, slave_union_key, is_master_tableid='Yes', is_slave_rec_number='Yes', is_delete_table='No')
 
def visible_item (self, table_name, item_name, is_visibility='Yes')
 
def xsum (self, table_name, setid, dimension_item_list, measure_item_list)
 
def load_arrow (self, table, columns=None)
 
def save_arrow (self, table_name, setid=-1, columns=None)
 
def read_parquet (self, table_name, file_name, columns=None)
 
def write_parquet (self, table_name, file_name, setid=-1, columns=None)
 
def start_sdc3 (self)
 
def get_data_type (self, table_name, item_name)
 

Properties

 LastMessage = property(fget=__get_message, fset=__set_message)
 

Detailed Description

データサービス(Gear-API)クラス

※ Jupyter notebook/labでGear-APIを使用する場合、dataServerへのパス指定が必須です。
※ macOSの場合、DYLD_LIBRARY_PATHでdi5engine/mac指へのパス指定が必須です。

Jupyter lab 起動例
  cd ESPERiCフォルダーのパス
  export PYTHONPATH=$(cd "./server/dataService" && pwd):$PYTHONPATH
  export PYTHONPATH=$(cd "./server" && pwd):$PYTHONPATH           ←←← start_sdc3 APIを使用するの場合のみ 必須
  export DYLD_LIBRARY_PATH=$(cd "./server/di5engine/mac" && pwd)  ←←← macOSの場合のみ 必須
  Jupyter Lab

Definition at line 4 of file 1.DataServiceEx.py.

Constructor & Destructor Documentation

◆ __init__()

def 1.DataServiceEx.__init__ (   self,
  is_macro_stop = False,
  is_language = "ja-JP" 
)
コンストラクタ

Parameters
----------
is_macro_stop : bool, default False
    実行エラーが発生した場合に中断するか否か
    (True:中断、False:続行)
is_language : str, default 'ja-JP'
    言語
    (ja-JP:日本語、en-US:英語)

Definition at line 19 of file 1.DataServiceEx.py.

Member Function Documentation

◆ add_realitem()

def 1.DataServiceEx.add_realitem (   self,
  table_name,
  add_position,
  new_item_name,
  item_type,
  file_name 
)
項目の追加

Parameters
----------
table_name : str
    テーブル名
add_position : str
    追加位置(項目名)項目がない場合は”RecNo”を指定
new_item_name : str
    追加項目名
item_type : str
    追加項目のデータ型(String:文字列、Integer:整数、Double:浮動小数、Time:時刻、Date:日付、DateTime:日付時刻)
file_name : str
    項目ファイル名(拡張子付き)空項目を追加する場合は空白””

Returns
-------
ResultCode : int
    結果コード(正:追加項目ID、負:エラーコード)

Examples
----------
テーブルpractice1に、整数型の項目1を空項目で追加する

========================================================================
>>>dsx.add_realitem(“practice1”,”RecNo”,”項目1”,”Integer”,””)
1
>>>dsx.get_itemlist(“practice1”)
[‘項目1’]
========================================================================

See Also
----------
1.項目一覧取得(get_itemlist)で、項目が追加されたことを確認できます
2.追加位置についてはテーブルデータ取得(get_tuple)で確認できます

====================================
>>>dsx.get_tuple("practice1",1,10,1)
[['SeqNo', 'RecNo'], ['1', '1']]
====================================

SeqNoとRecNoはテーブル作成時から既にある項目です

Definition at line 114 of file 1.DataServiceEx.py.

◆ append_row()

def 1.DataServiceEx.append_row (   self,
  table_name,
  row_count,
  start_row = 1 
)
行の追加

Parameters
----------
table_name : str
    テーブル名
row_count : int
    追加行数
start_row : int, default 1
    追加位置行

Returns
-------
ResultCode : int
    結果コード(正:追加行数、負:エラーコード)

Examples
----------
項目1の3行目に1行追加する

====================================================
>>> dsx.get_rowcount(“practice1”,1)
5
>>>dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘あ’,’い’,’う’,’え’,’お’]
>>>dsx.append_row(“practice1”,1,3)
1
>>> dsx.get_rowcount(“practice1”,1)
6
>>>dsx.get_cell(“practice1”,”項目1”,1,6,1)
[‘あ’,’い’,’う’,’’,’え’ ,’お’]
====================================================

See Also
----------
1.テーブルの行数取得(get_rowcount)で、行数が増えたことを確認できます
2.セルの値取得(get_cell)で、追加された行の位置を確認できます

Definition at line 210 of file 1.DataServiceEx.py.

◆ calc()

def 1.DataServiceEx.calc (   self,
  table_name,
  item_name,
  calc_string,
  row_count = -1,
  start_row = 1,
  setid = -1 
)
計算

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名
calc_string : str
    計算式
row_count : int, default -1
    行数(マイナス値は全行が対象)
start_row : int, default 1
    計算開始行
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
項目1の整数全行に×1000をする

===============================================================
>>>dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1’,’2’,’3’,’4’,’5’]
>>>dsx.calc(“practice1”,”項目1”,’*(@項目1,1000)’,-1,1,1)
0
>>>dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1000’,’2000’,’3000’,’4000’,’5000’]
===============================================================

Notes
----------
計算式のみシングルクォーテーションで括ります

See Also
----------
1.セルの値取得(get_cell)で、計算結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます
3.計算の構文についてはクッキングマニュアルのp.35,36をご参照ください

Examples
----------
項目1と項目2を文字列結合する

========================================================================================================================================
>>> dsx.get_tuple("practice1",1,50,1)
[['SeqNo', 'RecNo', '項目1', '項目2'], ['1', '1', 'ア', 'カ'], ['2', '2', 'イ', 'キ'], ['3', '3', 'ウ', 'ク']]
>>> dsx.calc("practice1","項目1",'$&($@項目1,$@項目2)',-1,1,1)
0
>>> dsx.get_tuple("practice1",1,50,1)
[['SeqNo', 'RecNo', '項目1', '項目2'], ['1', '1', 'アカ', 'カ'], ['2', '2', 'イキ', 'キ'], ['3', '3', 'ウク', 'ク']]
========================================================================================================================================

Notes
----------
計算式のみシングルクォーテーションで括ります

See Also
----------
1.テーブルデータ取得(get_tuple)で、文字列結合の結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます
3.計算の構文についてはクッキングマニュアルのp.35,36をご参照ください

Definition at line 260 of file 1.DataServiceEx.py.

◆ catalog()

def 1.DataServiceEx.catalog (   self,
  table_name,
  file_name,
  catalog_name,
  mode = None 
)
カタログファイル(StructInfo.txt)に従ってインポート


使用上の注意
CSVファイルとカタログファイル(StructInfo.txt)の文字エンコードは、エンジンのDB文字コードの設定と一致させて下さい。

カタログファイルは下記の形式で指定して下さい。

ファイル形式指定(必須)
//CSV        カンマ区切りファイル
//TAB        タブ区切りファイル
//FIX        固定長データファイル

文字コード(任意:CSVファイルの文字エンコードがエンジンのDB文字コードと異なる場合に指定)
//SHIFT-JIS  シフトJIS
//UTF-8      UTF-8
//MS932      MS932 (Windows 日本語)

オプション(任意:先頭の項目行を読み飛ばす場合に指定)
//CUTTOP     

dataType [tab] dataSize [tab] itemName
dataType は次のいずれかを指定
I : 整数
F : 浮動小数
A : 文字列
D : 日付
T : 時刻
E : 日付時刻
dataSize はデータの長さを指定(固定長データファイルの場合のみ有効)
itemName は項目名を指定
 
カタログファイルの指定例
//CSV
//CUTTOP
A [tab] [tab] 氏名
I [tab] [tab] 年齢
F [tab] [tab] 身長
F [tab] [tab] 体重


Parameters
----------
table_name : str
    テーブル名を定義
file_name : str
    インポートファイル名(拡張子付き)
catalog_name : str
    カタログファイル名(拡張子付き StructInfo.txt)

Returns
-------
ResultCode : int
    結果コード(正:テーブルID、負:エラーコード)

Definition at line 343 of file 1.DataServiceEx.py.

◆ categorize()

def 1.DataServiceEx.categorize (   self,
  table_name,
  item_name,
  category_table_name 
)
数値データのカテゴライズ

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名
category_table_name : str
    カテゴリテーブル名(カテゴリテーブルの内容はクッキングマニュアルを参照)

Returns
-------
ResultCode : int
    結果コード(正:作成した項目ID、負:エラーコード)

Examples
----------
項目1をカテゴリーテーブルcategorize1によってカテゴライズする

=====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================
※事前に作成したカテゴリーテーブルcategorize1をロードしています
>>> dsx.get_tablelist()
['practice1', 'categorize1']
>>> dsx.get_tuple("practice1",1,50,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', '1', '11', '21'], ['2', '2', '2', '12', '22'], ['3', '3', '3', '13', '23'], ['4', '4', '4', '14', '24'], ['5', '5', '5', '15', '25'], ['6', '6', '6', '16', '26'], ['7', '7', '7', '17', '27'], ['8', '8', '8', '18', '28'], ['9', '9', '9', '19', '29'], ['10', '10', '10', '20', '30']]
>>> dsx.categorize("practice1","項目1","categorize1")
23
>>> dsx.get_tuple("practice1",1,50,1)
[['SeqNo', 'RecNo', '項目1', 'categorize1_項目1_', '項目2', '項目3'], ['1', '1', '1', '奇数A', '11', '21'], ['2', '2', '2', '偶数A', '12', '22'], ['3', '3', '3', '奇 数B', '13', '23'], ['4', '4', '4', '偶数B', '14', '24'], ['5', '5', '5', '奇数C', '15', '25'], ['6', '6', '6', '偶数C', '16', '26'], ['7', '7', '7', '奇数D', '17', '27'], ['8', '8', '8', '偶数D', '18', '28'], ['9', '9', '9', '奇数E', '19', '29'], ['10', '10', '10', '偶数E', '20', '30']]
=====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

See Also
----------
1.テーブルデータ取得(get_tuple)で、カテゴライズを確認できます
2.数値カテゴライズおよびカテゴリ定義テーブルについては、クッキングマニュアルのp.75をご参照ください

Definition at line 442 of file 1.DataServiceEx.py.

◆ clear_ws()

def 1.DataServiceEx.clear_ws (   self)
ワークスペースをクリア

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
ワークスペースをクリアする 

======================================
>>>dsx.get_tablelist()
[‘practice1’,’practice2’,’practice3’]
>>>dsx.clear_ws()
0
>>>dsx.get_tablelist()
>>>
=======================================

See Also
----------
テーブル一覧取得(get_tablelist)で、ワークスペースをクリアしたことを確認できます

Definition at line 491 of file 1.DataServiceEx.py.

◆ comment()

def 1.DataServiceEx.comment (   self,
  comment 
)
コメントと時刻を表示

Parameters
----------
comment : str
    任意の文字列、DATETIMEは日付時刻を表示

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Definition at line 524 of file 1.DataServiceEx.py.

◆ compression()

def 1.DataServiceEx.compression (   self,
  table_name 
)
テーブルの圧縮・最適化

Parameters
----------
table_name : str
    テーブル名

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブルpractice1を圧縮する

===================================
>>>dsx.get_memory(“practice1”)
17528
>>>dsx.compression(“practice1”)
0
>>>dsx.get_memory(“practice1”)
17408
===================================

See Also
----------
使用メモリサイズ取得(get_memory)で、使用メモリサイズを確認できます

Definition at line 591 of file 1.DataServiceEx.py.

◆ convert_type()

def 1.DataServiceEx.convert_type (   self,
  table_name,
  item_name,
  data_type 
)
項目の型変換複製

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名    
data_type : str
    変換するデータ型(String:文字列、Integer:整数、Double:浮動小数、Time:時刻、Date:日付、DateTime:日付時刻)

Returns
-------
ResultCode : int
    結果コード(正:生成された項目ID、負:エラーコード)

Examples
----------
項目1のデータ型を整数から浮動小数に変換する

====================================================================
>>>dsx.get_itemlist(“practice1”)
[‘項目1’]
>>>dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1’,’2’,’3’,’4’,’5’]
>>>dsx.convert_type(“practice1”,”項目1”,”Double”)
24
>>>dsx.get_itemlist(“practice1”)
[‘項目1’,’項目1_#1’]
>>>dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1.0’,’2.0’,’3.0’,’4.0’,’5.0’]
====================================================================

See Also
----------
1.項目一覧取得(get_itemlist)で、項目が追加されたことを確認できます
2.セルの値取得(get_cell)で、値が型変換されたことを確認できます

Definition at line 3226 of file 1.DataServiceEx.py.

◆ create_table()

def 1.DataServiceEx.create_table (   self,
  row_count,
  table_name 
)
新規テーブルを作成

Parameters
----------
row_count : int
    行数
table_name : str
    テーブル名

Returns
-------
ResultCode : int
    結果コード(正:テーブルID、負:エラーコード)

Examples
----------
5行のテーブル、practice1を作成する

========================================
>>>dsx.create_table(5,”practice1”)
2
>>>dsx.get_tablelist()
[‘practice1’]
>>>dsx.get_rowcount(“practice1”,1)
5
========================================

See Also
----------
1.テーブル一覧取得(get_tablelist)で、テーブルが追加されたことを確認できます
2.テーブルの行数取得(get_rowcount)で、追加したテーブルの行数を確認できます

Definition at line 694 of file 1.DataServiceEx.py.

◆ db_codeset()

def 1.DataServiceEx.db_codeset (   self,
  db_codeset 
)
DB文字コードの設定

Parameters
----------
db_codeset : str
    DB文字コード(UTF-8 または Shift_JIS)

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
1.文字コードをUTF-8にする 

=========================
>>>dsx.db_codeset(“UTF8”)
0
=========================

2. 文字コードをSJISにする 

==============================
>>>dsx.db_codeset(“Shift_JIS”)
0
==============================

Definition at line 737 of file 1.DataServiceEx.py.

◆ db_load()

def 1.DataServiceEx.db_load (   self,
  file_name 
)
ワークスペース(D5Dファイル)ロード

Parameters
----------
file_name : str
    ワークスペースファイル名

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
==================================================================
>>>dsx.db_load("C:フォルダ\\フォルダ\\フォルダ\\practice99.D5D")
0
==================================================================

See Also
----------
D5Dファイル、D5Tファイルについてはクッキングマニュアルのp.2をご参照ください

Definition at line 775 of file 1.DataServiceEx.py.

◆ db_save()

def 1.DataServiceEx.db_save (   self,
  file_name 
)
ワークスペース(D5Dファイル)保存

Parameters
----------
file_name : str
    ワークスペースファイル名

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
=====================================================================
>>>dsx.db_save("C:フォルダ\\フォルダ\\フォルダ\\practice99.D5D")
0
=====================================================================

See Also
----------
D5Dファイル、D5Tファイルについてはクッキングマニュアルのp.2をご参照ください

Definition at line 808 of file 1.DataServiceEx.py.

◆ delete_allset()

def 1.DataServiceEx.delete_allset (   self,
  table_name 
)
すべてのセット(サブテーブル)の削除

Parameters
----------
table_name : str
    テーブル名

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブルpractice1のサブテーブルを全て削除する

================================================================================================
>>>dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1]=あ'], [3, "SearchStrExp Set:1 項目1='あ' ..."]]
>>>dsx.delete_allset("practice1")
0
>>>dsx.get_setid_list("practice1")
[[1, '']]
================================================================================================

See Also
----------
セットID一覧取得(get_setid_list)で、サブテーブルが削除されたことを確認できます

Definition at line 841 of file 1.DataServiceEx.py.

◆ delete_item()

def 1.DataServiceEx.delete_item (   self,
  table_name,
  item_name 
)
項目の削除

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
項目1を削除する

===========================================================
>>>dsx.get_itemlist(“practice1”)
[‘項目1’,’項目2’,’項目3’]
>>>dsx.delete_item(“practice1”,”項目1”)
0
>>>dsx.get_itemlist(“practice1”)
[’項目2’,’項目3’]
===========================================================

See Also
----------
項目一覧取得(get_itemlist)で、項目が削除されたことを確認できます

Definition at line 977 of file 1.DataServiceEx.py.

◆ delete_resultset()

def 1.DataServiceEx.delete_resultset (   self,
  table_name,
  setid 
)
検索リザルトセット(サブテーブル)の削除

Parameters
----------
table_name : str
    テーブル名
setid : int
    削除セットID

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブルpractice1の検索リザルトセットを削除する

====================================================================================
>>>dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1]=あ'], [3, "SearchStrExp Set:1 項目1='あ' ..."]]
>>>dsx.delete_resultset("practice1",3)
0
>>>dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1]=あ']]
=====================================================================================

See Also
----------
1.セットID一覧取得(get_setid_list)で、セットが削除されたことを確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 880 of file 1.DataServiceEx.py.

◆ delete_row()

def 1.DataServiceEx.delete_row (   self,
  table_name,
  start_row,
  row_count,
  setid = -1 
)
行の削除

Parameters
----------
table_name : str
    テーブル名
start_row : int
    削除開始行
row_count : int
    削除行数(マイナス値は全行が対象)
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultCode : int
    結果コード(正:削除行数、負:エラーコード)

Examples
----------
テーブルpractice1の3行目を削除する

==============================================================
>>>dsx.get_rowcount(“practice1”,1)
10
>>>dsx.get_cell(“practice1”,”項目1”,1,5,1)
[’あ’,’い’,’う’,’え’,’お’]
>>>dsx.delete_row(“practice1”,3,1,1)
1
>>>dsx.get_rowcount(“practice1”,1)
9
>>>dsx.get_cell(“practice1”,”項目1”,1,5,1)
[’あ’,’い’,’え’,’お’,’か’]
==============================================================

See Also
----------
1.テーブル行数取得(get_rowcount)で、行数の増減を確認できます
2.セルの値取得(get_cell)で、行が削除されたことを確認できます
3.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 923 of file 1.DataServiceEx.py.

◆ delete_set()

def 1.DataServiceEx.delete_set (   self,
  table_name,
  setid 
)
セット(サブテーブル)の削除

Parameters
----------
table_name : str
    テーブル名  
setid : int
    削除セットID

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブルpractice1のセットIDが3のサブテーブルを削除する

======================================================================================================================
>>>dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1]=あ'], [3, "SearchStrExp Set:1 項目1='あ' ..."]]
>>>dsx.delete_set(“practice1”,3)
2
>>>dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1]=あ']]
======================================================================================================================

See Also
----------
1.セットID一覧取得(get_setid_list)で、セットIDが削除されたことを確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 2799 of file 1.DataServiceEx.py.

◆ delete_table()

def 1.DataServiceEx.delete_table (   self,
  table_name 
)
テーブルをワークスペースから削除

Parameters
----------
table_name : str
    テーブル名

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブルpractice1を削除する

=======================================================
>>> dsx.get_tablelist()
[‘practice1’,’practice2’]
>>> dsx.delete_table(“practice1”)
0
>>> dsx.get_tablelist()
[’practice2’]
=======================================================

See Also
----------
テーブル一覧取得(get_tablelist)で、テーブルが削除されたことを確認できます

Definition at line 1019 of file 1.DataServiceEx.py.

◆ duplicate_item()

def 1.DataServiceEx.duplicate_item (   self,
  table_name,
  item_name 
)
項目の複製

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名    

Returns
-------
ResultCode : int
    結果コード(正:複製された項目ID、負:エラーコード)

Examples
----------
項目1を複製する 

===============================================================
>>> dsx.get_itemlist(“practice1”)
[‘項目1’,’項目2’]
>>> dsx.duplicate_item(“practice1”,”項目1”)
23
>>> dsx.get_itemlist(“practice1”)
[‘項目1’, ‘項目1_#1’,’項目2’]
================================================================

See Also
----------
項目一覧取得(get_itemlist)で、項目1が複製され項目1_#1が追加されたことを確認できます

Definition at line 1097 of file 1.DataServiceEx.py.

◆ duplicate_table()

def 1.DataServiceEx.duplicate_table (   self,
  table_name 
)
テーブルの複製

Parameters
----------
table_name : str
    テーブル名

Returns
-------
ResultCode : int
    結果コード(正:複製されたテーブルID、負:エラーコード)

Examples
----------
テーブルpractice1を複製する

==========================================================
>>> dsx.get_tablelist()
[‘practice1’]
>>> dsx.duplicate_table(“practice1”)
4
>>> dsx.get_tablelist()
[‘practice1’,’practice1_#1’]
==========================================================

See Also
----------
テーブル一覧取得(get_tablelist)で、複製されたテーブルを確認できます

Definition at line 1058 of file 1.DataServiceEx.py.

◆ edit_comma()

def 1.DataServiceEx.edit_comma (   self,
  table_name,
  item_name,
  is_edit = 'Yes' 
)
カンマ編集

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名
is_edit : str, default 'Yes'
    3桁区切りするか否か(Yes/No)

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブルpractice1の項目1に3桁区切りでカンマをつける

==================================================
>>> dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1000’,’2000’,’3000’,’4000’,’5000’]
>>> dsx.edit_comma(“practice1”,”項目1”,”Yes”)
0
>>> dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1,000’,’2,000’,’3,000’,’4,000’,’5,000’]
==================================================

See Also
----------
セルの値取得(get_cell)で、カンマがついていることを確認できます

Definition at line 545 of file 1.DataServiceEx.py.

◆ extract_set()

def 1.DataServiceEx.extract_set (   self,
  table_name,
  setid,
  is_view_table_id = 'Yes',
  is_record_number = 'Yes',
  item_name_list = '*',
  new_table_name = None 
)
サブテーブル(セット)を実テーブルに抽出

Parameters
----------
table_name : str
    テーブル名
setid : int
    セットID  
is_view_table_id : str, default 'Yes'
    Yes:テーブルIDを表示する、No:表示しない
is_record_number : str, default 'Yes'
    Yes:RecNoを出力する、N0:出力しない     
item_name_list : list, default '*'
    抽出項目名リスト("*"は全項目が対象)    
new_table_name : str, default None
    抽出後のテーブル名(省略可)             

Returns
-------
ResultCode : int
    結果コード(正:生成されたテーブルID、負:エラーコード)

Examples
----------
テーブルpractice1のサブテーブル(値リスト検索結果)を実テーブルに抽出する

==========================================================================
>>> dsx.get_tablelist()
['practice1']
>>> dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1] = 値リスト']]
>>> dsx.extract_set("practice2",2,"No","Yes",["項目1"],"set1")
5
>>> dsx.get_tablelist()
['practice1','set1']
==========================================================================

See Also
----------
1.テーブル一覧取得(get_tablelist)で、実テーブルに抽出したことを確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 1139 of file 1.DataServiceEx.py.

◆ extract_unique()

def 1.DataServiceEx.extract_unique (   self,
  table_name,
  setid,
  item_name_list = '*',
  is_keep_order = 'Yes' 
)
ユニーク行の抽出

Parameters
----------
table_name : str
    テーブル名
setid : int
    セットID  
item_name_list : list, default '*'
    抽出項目名リスト("*"は全項目が対象)
is_keep_order : str, default 'Yes'
    Yes:元の順序を保つ、No:保たない    

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
項目1のユニーク行を抽出する

===================================================================================================================================================================================================================================
>>> dsx.get_tuple("practice1",1,20,1)
[['SeqNo', 'RecNo', '項目1'], ['1', '1', 'あ'], ['2', '2', 'あ'], ['3', '3', 'い'], ['4', '4', 'う'], ['5', '5', 'う'], ['6', '6', 'え'], ['7', '7', 'え'], ['8', '8', 'お'], ['9', '9', 'お'], ['10', '10', 'お']]
>>>dsx.extract_unique(“practice1”,1,[“項目1”],”Yes”)
2
>>> dsx.get_tuple("practice1",1,20,2)
[['SeqNo', 'RecNo', '項目1'], ['1', '1', 'あ'], ['2', '3', 'い'], ['3', '4', 'う'], ['4', '6', 'え'], ['5', '8', 'お']]
===================================================================================================================================================================================================================================

Notes
----------
ユニーク行を抽出した際に生成されたセットIDが2なので、結果確認のテーブルデータ取得では引数(セットID)が2となります
See Also
----------
1.テーブルデータ取得(get_tuple)で、ユニーク行を抽出したことを確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 1196 of file 1.DataServiceEx.py.

◆ fill_cell()

def 1.DataServiceEx.fill_cell (   self,
  table_name,
  item_name,
  set_string,
  start_row = 1,
  row_count = -1,
  setid = -1 
)
セルに値を入力

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名
set_string : str
    入力文字列                              
start_row : int, default 1
    開始行
row_count : int, default -1
    行数(マイナス値は全行が対象)          
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultCode : int
    結果コード(正:データ数、負:エラーコード)

Examples
----------
項目1の値を全て”あ”にする

===========================================================================
>>> dsx.fill_cell(“practice1”,”項目1”,”あ”,1,-1,1)
>>> dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘あ’,’あ’,’あ’,’あ’,’あ’]
===========================================================================

See Also
----------
1.セルの値取得(get_cell)で、入力結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます
3.同じ値を複数入力したい場合は値を入力(fill_cell)、違う値を複数入力したい場合は値書込み(set_cell)がおすすめです

Definition at line 1248 of file 1.DataServiceEx.py.

◆ float_format()

def 1.DataServiceEx.float_format (   self,
  table_name,
  item_name,
  digit 
)
浮動小数データの小数点以下桁数を設定

Parameters
----------
table_name : str
    テーブル名 
item_name : str
    項目名     
digit : int
    桁数 0~15 

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
浮動小数型の項目1の小数点以下を1桁にする

========================================================================
>>> dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1.000’,’2.000’,’3.000’,’4.000’,’5.000’]
>>> dsx.float_format(“practice1”,”項目1”,1)
0
>>> dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1.0’,’2.0’,’3.0’,’4.0’,’5.0’]
========================================================================

See Also
----------
セルの値取得(get_cell)で、小数点以下の桁数を確認できます

Definition at line 1387 of file 1.DataServiceEx.py.

◆ get_cell()

def 1.DataServiceEx.get_cell (   self,
  table_name,
  item_name,
  start_row = 1,
  row_count = 1,
  setid = -1 
)
セルの値取得

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名
start_row : int, default 1
    開始行
row_count : int, default 1
    行数  
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultList : list
    セル値リスト(文字列)

Examples
----------
項目1の先頭から5行分のセルの値を取得する

======================================================================
>>> dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘1000’,’2000’,’3000’,’4000’,’5000’]
======================================================================

See Also
----------
セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 1432 of file 1.DataServiceEx.py.

◆ get_data_type()

def 1.DataServiceEx.get_data_type (   self,
  table_name,
  item_name 
)
項目のデータ型

# 整数      :2
# 浮動小数  :3
# 日付      :4
# 時刻      :5
# 文字列    :6
# 日付時刻  :7
# NUMERIC   :8


Parameters
----------
table_name : str
    テーブル名 
item_name : str
    項目名     

Returns
-------
ResultCode : int
    結果コード(2 ~ 8:成功、負:エラーコード)

Definition at line 3630 of file 1.DataServiceEx.py.

◆ get_itemlist()

def 1.DataServiceEx.get_itemlist (   self,
  table_name 
)
項目一覧取得

Parameters
----------
table_name : str
    テーブル名

Returns
-------
ResultList : list
    項目名リスト

Examples
----------
テーブルpractice1の項目一覧を取得する

==============================================================
>>> dsx.get_itemlist(“practice1”)
[‘項目1’]
==============================================================

Definition at line 1599 of file 1.DataServiceEx.py.

◆ get_license_expiration()

def 1.DataServiceEx.get_license_expiration (   self)
ライセンス有効期限取得

Returns
-------
ResultStr : str
    日付文字列

Definition at line 1630 of file 1.DataServiceEx.py.

◆ get_limit_cpu()

def 1.DataServiceEx.get_limit_cpu (   self)
使用可能CPU数(ライセンス情報)取得

Returns
-------
ResultLong : int
    CPU数

Definition at line 1645 of file 1.DataServiceEx.py.

◆ get_limit_memory()

def 1.DataServiceEx.get_limit_memory (   self)
使用可能メモリサイズ(ライセンス情報)取得

Returns
-------
ResultLong : long
    メモリサイズ

Definition at line 1691 of file 1.DataServiceEx.py.

◆ get_limit_row()

def 1.DataServiceEx.get_limit_row (   self)
最大行数(ライセンス情報)取得

Returns
-------
ResultLong : long
    行数

Definition at line 1706 of file 1.DataServiceEx.py.

◆ get_memory()

def 1.DataServiceEx.get_memory (   self,
  table_name 
)
テーブルの使用メモリサイズ取得

Parameters
----------
table_name : str
    テーブル名

Returns
-------
ResultLong : long
    メモリサイズ

Examples
----------
テーブルpractice1の使用メモリサイズを取得する

==============================================================
>>> dsx.get_memory(“practice1”)
16444
==============================================================

Definition at line 1660 of file 1.DataServiceEx.py.

◆ get_rowcount()

def 1.DataServiceEx.get_rowcount (   self,
  table_name,
  setid = -1 
)
テーブルの行数取得

Parameters
----------
table_name : str
    テーブル名
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultCode : int
    結果コード(正:セットの行数、負:エラーコード)

Examples
----------
テーブルpractice1の行数を取得する

================================================================
>>> dsx.get_rowcount(“practice1”,1)
5
================================================================

See Also
----------
セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 1742 of file 1.DataServiceEx.py.

◆ get_setid_list()

def 1.DataServiceEx.get_setid_list (   self,
  table_name 
)
セットID一覧取得

Parameters
----------
table_name : str
    テーブル名

Returns
-------
ResultIntList : list
    セットリスト [ID, アトリビュート]

Definition at line 1721 of file 1.DataServiceEx.py.

◆ get_tablelist()

def 1.DataServiceEx.get_tablelist (   self)
テーブル一覧取得

Returns
-------
ResultList : list
    テーブル名リスト

Examples
----------
チューボーにあるテーブル一覧を取得する

======================================================
>>> dsx.get_tablelist()
[‘practice1’]
======================================================

Definition at line 1780 of file 1.DataServiceEx.py.

◆ get_tablename()

def 1.DataServiceEx.get_tablename (   self,
  tableid 
)
テーブル名取得

Parameters
----------
tableid : int
    テーブルID

Returns
-------
ResultStr : str
    テーブル名

Examples
----------
テーブルID1~3のテーブル名を取得する

==============================================================
>>>dsx.get_tablelist()
['practice1', 'practice2', 'practice3']
>>> dsx.get_tablename(1)
'practice1'
>>> dsx.get_tablename(2)
'practice2'
>>> dsx.get_tablename(3)
'practice3'
===============================================================

Notes
----------
テーブルIDは自動的にロードした順でつけられます

See Also
----------
テーブル一覧取得(get_tablelist)で全てのテーブルを確認できます

Definition at line 1805 of file 1.DataServiceEx.py.

◆ get_tuple()

def 1.DataServiceEx.get_tuple (   self,
  table_name,
  start_row = 1,
  fetch_size = 128,
  setid = -1 
)
テーブルデータ取得

Parameters
----------
table_name : str
    テーブル名
start_row : int, default 1
    取得開始行
fetch_size : int, default 128
    取得行数(省略した場合はデフォルト値) 
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultList : list
    文字列に変換した行配列データ(先頭行はカラム名配列)

Examples
----------
テーブルpractice1のテーブルデータを取得する

===================================================================================================================================================================================================================================
>>> dsx.get_tuple("practice1",1,30,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し'], ['3', '3', 'う', ' く', 'す'], ['4', '4', 'え', 'け', 'せ'], ['5', '5', 'お', 'こ', 'そ']]
===================================================================================================================================================================================================================================

Notes
----------
1つ目のリスト[SeqNo, RecNo,項目1,項目2,項目3]は列名(項目名)、2つ目以降のリスト内の値は列(項目)の順になっています

See Also
----------
セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 1524 of file 1.DataServiceEx.py.

◆ get_tuple_asjson()

def 1.DataServiceEx.get_tuple_asjson (   self,
  table_name,
  start_row = 1,
  fetch_size = 128,
  setid = -1 
)
テーブルデータをJSON形式で取得

Parameters
----------
table_name : str
    テーブル名
start_row : int, default 1
    取得開始行
fetch_size : int, default 128
    取得行数(省略した場合はデフォルト値) 
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultList : list
    文字列に変換したJSON配列データ

Examples
----------
テーブルpractice1をJSON形式で取得する

=============================================================================================================================================================================================================================================================================================================================================================================================================
>>> dsx.get_tuple_asjson("practice1",1,10,1)
[{'SeqNo': '1', 'RecNo': '1', '項目1: 'あ', '項目2': 'か', '項目3': 'さ' }, {'SeqNo': '2', 'RecNo': '2', ' 項目1': 'い', '項目2': 'き', '項目3': 'し'}, {'SeqNo': '3', 'RecNo': '3', '項目1': 'う', '項目2': 'く', '項目3': 'す' }, {'SeqNo': '4', 'RecNo': '4', '項目1': 'え', '項目2': 'け', '項目3': 'せ'}, {'SeqNo': '5', 'RecNo': '5', '項目1': 'お', '項目2': 'こ', '項目3': 'そ'}]
=============================================================================================================================================================================================================================================================================================================================================================================================================

See Also
----------
セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 1479 of file 1.DataServiceEx.py.

◆ get_valuelist()

def 1.DataServiceEx.get_valuelist (   self,
  table_name,
  setid,
  item_name 
)
値リスト取得

Parameters
----------
table_name : str
    テーブル名
setid : int
    セットID  
item_name : str
    項目名    

Returns
-------
ResultList : list
    値リスト(最大5,000行、5,000行を超えた場合は後を切り捨て)

Examples
----------
項目1の値リストを取得する

===============================================================
>>> dsx.get_valuelist("practice1",1,"項目1")
['', 'あ', 'い', 'う', 'え', 'お']
===============================================================

See Also
----------
セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 1850 of file 1.DataServiceEx.py.

◆ get_version()

def 1.DataServiceEx.get_version (   self)
バージョン番号取得

Returns
-------
ResultStr : str
    バージョン番号

Examples
----------
SDCV3のバージョンを取得する

=================================================
>>> dsx.get_version()
‘2,22,0,1’
=================================================

Definition at line 1891 of file 1.DataServiceEx.py.

◆ insert_row()

def 1.DataServiceEx.insert_row (   self,
  table_name,
  row_count,
  start_row = 1 
)
行の挿入

Parameters
----------
table_name : str
    テーブル名
row_count : int
    挿入行数  
start_row : int, default 1
    挿入位置行

Returns
-------
ResultCode : int
    結果コード(正:挿入行数、負:エラーコード)

Examples
----------
テーブルpractice1の3行目に1行挿入する

=======================================================================
>>> dsx.get_rowcount(“practice1”,1)
5
>>> dsx.get_cell("practice1","項目1",1,5,1)
['あ', 'い', 'う', 'え', 'お']
>>> dsx.insert_row("practice1",1,3)
1
>>> dsx.get_rowcount(“practice1”,1)
6
>>> dsx.get_cell("practice1","項目1",1,6,1)
['あ', 'い', '','う', 'え', 'お']
=======================================================================

See Also
----------
1.テーブルの行数取得(get_rowcount)で、行数の増減を確認できます
2.セルの値取得(get_cell)で、行の挿入位置を確認できます

Definition at line 1968 of file 1.DataServiceEx.py.

◆ join()

def 1.DataServiceEx.join (   self,
  table_name,
  master_table_name,
  slave_table_name,
  master_setid,
  slave_setid,
  master_join_key,
  slave_join_key,
  is_in_out,
  is_transfer_item = 'No' 
)
JOINテーブルを作成

Parameters
----------
table_name : str
    JOINテーブル名
master_table_name : str
    マスターテーブル名
slave_table_name : str
    スレーブテーブル名
master_setid : int
    マスターセットID
slave_setid : int
    スレーブセットID
master_join_key : list
    マスター側JOINキーリスト
slave_join_key : list
    スレーブ側JOINキーリスト
is_in_out : str
    Inner:内部JOIN、Outer:外部JOIN
is_transfer_item : str, default 'No'
    Yes:項目転送あり、No:なし

Returns
-------
ResultCode : int
    結果コード(正:JOINテーブルID、負:エラーコード)

Examples
----------
テーブルpractice1とpractice2を内部結合(InnerJOIN)する

===============================================================================================================================================================================================================================================
>>> dsx.join("join1","practice1","practice2",1,1,["項目1"],["項目1"],"Inner","No")
6
>>> dsx.get_tablelist()
['practice1', 'practice2','join1']
>>> dsx.get_tuple("join1",1,50,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3', '項目1_#1', '項目2_#1', '項目3_#1'], ['1', '1', 'あ', 'か', 'さ', 'ア', 'カ', 'サ'], ['2', '2', 'い', 'き', 'し','イ', 'キ', 'シ'], ['3', '3', 'う', 'く', 'す', 'ウ', 'ク', 'ス']]
===============================================================================================================================================================================================================================================

See Also
----------
1.テーブル一覧取得(get_tablelist)で、JOINテーブルが追加されたことを確認できます
2.テーブルデータ取得(get_tuple)で、結合結果を確認できます

Definition at line 630 of file 1.DataServiceEx.py.

◆ join_inout()

def 1.DataServiceEx.join_inout (   self,
  table_name,
  is_slave,
  is_in_out 
)
JOINテーブルのIN/OUT集合サブテーブル化

Parameters
----------
table_name : str
    JOINテーブル名
isSlave : str
    Yes:スレーブテーブルより抽出、No:マスターテーブルより抽出
isJoinOut : str
    IN:IN集合、OUT:OUT集合

Returns
-------
ResultIntList : list
    結果配列(セットが追加されたテーブルIDと生成されたセットID)

Examples
----------
JOINテーブルjoin1のIN集合をサブテーブル化する

===================================================================================================================================================================================================================================
※practice1とpractice2をJOINしたものがjoin1となっています
>>> dsx.get_tablelist()
['practice1', 'practice2', 'join1']
>>> dsx.get_setid_list("practice1")
[[1, '']
>>> dsx.join_inout("join1","No","IN")
[2, 2]
>>> dsx.get_tablename("2")
'practice1'
>>> dsx.get_setid_list("practice1")
[[1, ''], [2, 'JoinIN isSlave No']]
>>> dsx.get_tuple("practice1",1,20,2)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3', '項目1_#1'], ['1', '1', 'あ', 'か', 'さ', 'ア'], ['2', '2', 'い', 'き', 'し', 'イ'], ['3', '3', 'う', 'く', 'す', 'ウ']]
===================================================================================================================================================================================================================================

See Also
----------
セットID一覧取得(get_setid_list)で、JOINテーブルがサブテーブル化したことを確認できます

Definition at line 1916 of file 1.DataServiceEx.py.

◆ join_realize()

def 1.DataServiceEx.join_realize (   self,
  join_table_name,
  real_table_name,
  setid,
  master_rec_number = 'Yes',
  slave_rec_number = 'Yes',
  item_name_list = '*' 
)
JOINテーブルをREALテーブルに変換

Parameters
----------
join_table_name : str
    JOINテーブル名
real_table_name : str
    REALテーブル名
setid : int
    セットID      
master_rec_number : str, default 'Yes'
    Yes:マスターテーブルのRecNoを出力する、No:出力しない
slave_rec_number : str, default 'Yes'
    Yes:スレーブテーブルのRecNoを出力する、No:出力しない
item_name_list : list, default '*'
    項目名リスト("*"は全項目が対象)

Returns
-------
ResultCode : int
    結果コード(正:REALテーブルID、負:エラーコード)

Examples
----------
JOINテーブルjoin1をREALテーブルに変換する

===========================================================================================
>>> dsx.join_realize("join1","real1",1,"No","No",["*"])
7
>>> dsx.get_tablelist()
['practice1', 'practice2', 'join1', 'real1']
===========================================================================================

See Also
----------
1.テーブル一覧取得(get_tablelist)で、JOINテーブルを変換したREALテーブルが追加されたことを確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 2018 of file 1.DataServiceEx.py.

◆ load()

def 1.DataServiceEx.load (   self,
  file_name 
)
テーブル(D5Tファイル)ロード

Parameters
----------
file_name : str
    テーブルファイル名    

Returns
-------
ResultCode : int
    結果コード(正:テーブルID、負:エラーコード)

Examples
----------
D5Tファイル”practice1”をロードする 

==========================================================================
>>> dsx.load(フォルダ\\フォルダ\\フォルダ\\practice1.D5T)
3
>>> dsx.get_tablelist()
[‘practice1’]
==========================================================================

See Also
----------
テーブル一覧取得(get_tablelist)で、チューボーにテーブルをロードしたことを確認できます

Definition at line 2071 of file 1.DataServiceEx.py.

◆ load_arrow()

def 1.DataServiceEx.load_arrow (   self,
  table,
  columns = None 
)
Apache Arrow(インメモリ)形式のテーブルを読み込む

※ pyarrow(Python Lib.)のインストールが必要です。

Parameters
----------
table : pyarrow.Table
    Apache Arrow Tableオブジェクト
columns : list, default None
    抽出カラム名リスト(省略時は全カラムが対象)    

Returns
-------
ResultCode : str
    テーブル名、None:エラー

Definition at line 3467 of file 1.DataServiceEx.py.

◆ move_currentset()

def 1.DataServiceEx.move_currentset (   self,
  table_name,
  setid 
)
カレントセット(サブテーブル)の移動

Parameters
----------
table_name : str
    テーブル名  
setid : int
    移動セットID

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
セットIDが2のサブテーブルに移動する(カレントセットを移動する)

================================================================
>>> dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1] = 値リスト']]
>>> dsx.move_currentset("practice1",2)
0
=================================================================

See Also
----------
セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 2759 of file 1.DataServiceEx.py.

◆ move_item()

def 1.DataServiceEx.move_item (   self,
  table_name,
  item_name_list,
  item_name 
)
項目の移動

Parameters
----------
table_name : str
    テーブル名          
item_name_list : list
    移動対象項目名リスト
item_name : str
    移動先項目名        

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
項目1を項目3の位置へ移動する

=========================================================
>>> dsx.get_itemlist("practice1")
['項目1', '項目2', '項目3']
>>> dsx.move_item("practice1",["項目1"],"項目3")
0
>>> dsx.get_itemlist("practice1")
['項目2', '項目3', '項目1']
=========================================================

See Also
----------
項目一覧取得(get_itemlist)で、項目が移動したことを確認できます

Definition at line 2123 of file 1.DataServiceEx.py.

◆ output_log()

def 1.DataServiceEx.output_log (   self,
  is_content = 'No',
  is_result = 'Yes',
  is_recipe = 'No',
  is_document = 'No' 
)
ログの出力制御

Parameters
----------
is_content : str, default 'No'
    実行内容ログ出力  Yes:出力あり、No:出力なし
is_result : str, default 'Yes'
    実行結果ログ出力  Yes:出力あり、No:出力なし
is_recipe : str, default 'No'
    レシピ出力  Yes:出力あり、No:出力なし
is_document : str, default 'No'
    レシピドキュメント出力  Yes:出力あり、No:出力なし

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Definition at line 84 of file 1.DataServiceEx.py.

◆ overwrite()

def 1.DataServiceEx.overwrite (   self,
  table_name,
  item_name,
  start_row,
  row_count,
  fill_string_list,
  is_ex_space = 'No',
  setid = -1 
)
セルの上書き

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名
start_row : int
    開始行
row_count : int
    行数(入力文字列数以下)                
fill_string_list : list
    入力文字列リスト                        
is_ex_space : str, default 'No'
    Yes:末尾空白を削除する、No:削除しない 
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultCode : int
    結果コード(正:データ数、負:エラーコード)

Definition at line 2198 of file 1.DataServiceEx.py.

◆ overwrite_batch()

def 1.DataServiceEx.overwrite_batch (   self,
  table_name,
  start_row,
  row_count,
  fill_string_list,
  setid = -1 
)
セルの上書き

Parameters
----------
table_name : str
    テーブル名
start_row : int
    開始行
row_count : int
    行数(入力文字列数以下)
fill_string_list : カラム = [[] for i in range(len(ヘッダーカラム))]
    入力文字列リスト(カラム単位での2次元配列)
setid : int, default -1
    セットID(省略した場合はカレントセット)

Returns
-------
ResultCode : int
    結果コード(正:データ数、負:エラーコード)

Definition at line 2237 of file 1.DataServiceEx.py.

◆ read_csv()

def 1.DataServiceEx.read_csv (   self,
  table_name,
  file_name 
)
CSVファイルのインポート


使用上の注意
1. CSVファイルの文字エンコードは、エンジンのDB文字コードの設定と一致させて下さい。
2. CSVファイルの先頭は項目行として、この行の内容で項目名を決定します。
3. CSVファイルの先頭数行の内容を調べて、各項目のデータタイプを決定します。
4. 期待通りのデータタイプでテーブルが作成されない場合、項目の型変換を行って下さい。または catalog でインポートして下さい。

Parameters
----------
table_name : str
    テーブル名を定義
file_name : str
    インポートファイル名(拡張子付き)

Returns
-------
ResultCode : int
    結果コード(正:テーブルID、負:エラーコード)

Definition at line 410 of file 1.DataServiceEx.py.

◆ read_parquet()

def 1.DataServiceEx.read_parquet (   self,
  table_name,
  file_name,
  columns = None 
)
Parquetファイルのインポート

※ pyarrow(Python Lib.)のインストールが必要です。

Parameters
----------
table_name : str
    テーブル名を定義
file_name : str
    インポートファイル名(拡張子付き)
columns : list, default None
    抽出カラム名リスト(省略時は全カラムが対象)    

Returns
-------
ResultCode : int
    結果コード(正:テーブルID、負:エラーコード)

Definition at line 3528 of file 1.DataServiceEx.py.

◆ rename_item()

def 1.DataServiceEx.rename_item (   self,
  table_name,
  item_name,
  new_item_name 
)
項目名を変更

Parameters
----------
table_name : str
    テーブル名  
item_name : str
    変更前項目名
new_item_name : str
    変更後項目名

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
項目名を項目1からitem1に変更する

===================================================================
>>> dsx.get_itemlist(“practice1”)
[‘項目1’]
>>> dsx.rename_item(“practice1”,”項目1”,”item1”)
0
>>> dsx.get_itemlist(“practice1”)
[‘item1’]
====================================================================

See Also
----------
項目一覧取得(get_itemlist)で項目名が変更したことを確認できます

Definition at line 2312 of file 1.DataServiceEx.py.

◆ rename_table()

def 1.DataServiceEx.rename_table (   self,
  table_name,
  new_table_name 
)
テーブル名を変更

Parameters
----------
table_name : str
    変更前テーブル名
new_table_name : str
    変更後テーブル名

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブル名をpractice1からpractice2に変更する

============================================================
>>> dsx.get_tablelist()
[‘practice1’]
dsx.rename_table(“practice1”,”practice2”)
0
>>> dsx.get_tablelist()
[‘practice2’]
============================================================

See Also
----------
テーブル一覧取得(get_tablelist)でテーブル名が変更したことを確認できます

Definition at line 2270 of file 1.DataServiceEx.py.

◆ save()

def 1.DataServiceEx.save (   self,
  file_name 
)
テーブル(D5Tファイル)保存

Parameters
----------
file_name : str
    テーブルファイル名          

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブルpractice1を保存する
===========================================================================
>>> dsx.save(“フォルダ\\フォルダ\\フォルダ\\practice1.D5T”)
0
===========================================================================

See Also
----------
D5Dファイル、D5Tファイルについてはクッキングマニュアルのp.2をご参照ください

Definition at line 2357 of file 1.DataServiceEx.py.

◆ save_arrow()

def 1.DataServiceEx.save_arrow (   self,
  table_name,
  setid = -1,
  columns = None 
)
テーブルをApache Arrow(インメモリ)形式で書き出す

※ pyarrow(Python Lib.)のインストールが必要です。

Parameters
----------
table_name : str
    テーブル名
setid : int, default -1
    セットID(省略した場合はカレントセット)
columns : list, default None
    抽出項目名リスト(省略時は全項目が対象)

Returns
-------
ResultCode : pyarrow.Table
    arrow.Tableオブジェクト、None:エラー

Definition at line 3496 of file 1.DataServiceEx.py.

◆ search()

def 1.DataServiceEx.search (   self,
  table_name,
  item_name,
  setid,
  search_string 
)
検索

Parameters
----------
table_name : str
    テーブル名    
item_name : str
    検索対象項目名
setid : int
    セットID      
search_string : str
    検索条件式(=、<>、<=、<、>=、>、string*、*string*、*string、IS NULL、IS NOT NULL)

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
テーブルpractice1の項目1で、”あ”以外の値を検索する

=====================================================================
>>> dsx.search(“practice1”,”項目1”,1,”[項目1]<>あ”)
2
>>> dsx.get_cell(“practice1”,”項目1”,1,5,2)
[‘い’,’う’,’え’,’お’,’か’]
=====================================================================

Notes
----------
検索した際に生成されたセットIDが2なので、セルの値取得での引数(セットID)は2となります

See Also
----------
1.セルの値取得(get_cell)で検索結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 2391 of file 1.DataServiceEx.py.

◆ search_string()

def 1.DataServiceEx.search_string (   self,
  table_name,
  setid,
  expression 
)
文字列検索式による検索

Parameters
----------
table_name : str
    テーブル名  
setid : int
    セットID    
expression : str
    文字列検索式(検索式の種類と構文はクッキングマニュアルを参照)

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
性別が男性かつ年齢が20歳を超えている人の苗字を検索する

================================================================================
>>> dsx.search_string(“practice1”,1,”性別 = ’男性’ AND 年齢 <= ’20’”)
2
>>> dsx.get_cell(“practice1”,”苗字”,1,5,2)
[‘相澤’,’青木’,’秋元’,’朝倉’,’在原’]
================================================================================

Notes
----------
1.検索した際に生成されたセットIDが2なので、セルの値取得での引数(セットID)は2となります
2.文字列検索では、検索の機能に加えAND、ORの指定が可能です

See Also
----------
1.セルの値取得(get_cell)で検索結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 2561 of file 1.DataServiceEx.py.

◆ search_values()

def 1.DataServiceEx.search_values (   self,
  table_name,
  item_name,
  setid,
  search_string_list 
)
値リスト検索

Parameters
----------
table_name : str
    テーブル名    
item_name : str
    検索対象項目名
setid : int
    セットID      
search_string_list : list
    検索値文字列リスト

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
項目1の値が”あ”,“い”,”う”のデータのみ取得する

===================================================================================================================================================================================================================================
>>> dsx.get_tuple("practice1",1,20,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し'], ['3', '3', 'う', 'く', 'す'], ['4', '4', 'え', 'け', 'せ'], ['5', '5', 'お', 'こ', 'そ']]
>>> dsx.search_values("practice2","項目1",1,[" あ","い","う"])
3
>>> dsx.get_tuple("practice1",1,20,3)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し'], ['3', '3', 'う', 'く', 'す']]
===================================================================================================================================================================================================================================

Notes
----------
値リスト検索で生成されたセットIDが3なので、検索結果確認のテーブルデータ取得では引数(セットID)が3となります

See Also
----------
1.テーブルデータ取得で、検索結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 2442 of file 1.DataServiceEx.py.

◆ search_values_bycsv()

def 1.DataServiceEx.search_values_bycsv (   self,
  table_name,
  item_name,
  setid,
  file_name 
)
値リスト検索(CSVファイル指定)

Parameters
----------
table_name : str
    テーブル名    
item_name : str
    検索対象項目名
setid : int
    セットID      
file_name : str
    CSVファイル名

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Definition at line 2495 of file 1.DataServiceEx.py.

◆ search_values_bytable()

def 1.DataServiceEx.search_values_bytable (   self,
  table_name,
  item_name,
  setid,
  list_table_name,
  list_item_name,
  list_setid 
)
値リスト検索(他テーブル指定)

Parameters
----------
table_name : str
    テーブル名            
item_name : str
    検索対象項目名        
setid : int
    セットID              
list_table_name : str
    値リスト取得テーブル名
list_item_name : str
    値リスト取得項目名    
list_setid : int
    値リスト取得セットID  

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Definition at line 2525 of file 1.DataServiceEx.py.

◆ set_cell()

def 1.DataServiceEx.set_cell (   self,
  table_name,
  item_name,
  start_row,
  row_count,
  fill_string_list,
  setid = -1 
)
セルに値書込み

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名
start_row : int
    開始行
row_count : int
    行数  
fill_string_list : list
    書込み値文字列リスト                    
setid : int
    セットID(省略した場合はカレントセット)

Returns
-------
ResultCode : int
    結果コード(正:データ数、負:エラーコード)

Examples
----------
項目1をあ行にする

==============================================================================
>>> dsx.set_cell(“practice1”,”項目1”,1,5,[”あ”,”い”,”う”,”え”,”お”],1)
>>> dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘あ’,’い’,’う’,’え’,’お’]
==============================================================================

See Also
----------
1.セルの値取得(get_cell)で、書込み結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます
3.同じ値を複数入力したい場合は値を入力(fill_cell)、違う値を複数入力したい場合は値書込み(set_cell)がおすすめです

Definition at line 2660 of file 1.DataServiceEx.py.

◆ set_comment()

def 1.DataServiceEx.set_comment (   self,
  table_name,
  setid,
  comment_string 
)
サブテーブル(セット)のコメント編集

Parameters
----------
table_name : str
    テーブル名    
setid : int
    セットID      
comment_string : str
    コメント文字列

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
テーブルpractice1のセット(Search Set)のコメントを編集する

==================================================================
>>> dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1] = 値リスト']]
>>> dsx.set_comment("practice1",2,"検索リスト")
0
>>> dsx.get_setid_list("practice1")
[[1, ''], [2, '検索リスト']]
==================================================================

See Also
----------
1.セットID一覧取得(get_setid_list)でセットのコメントが変更したことを確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 2713 of file 1.DataServiceEx.py.

◆ set_license()

def 1.DataServiceEx.set_license (   self,
  license_key 
)
ライセンスキーの設定

Parameters
----------
license_key : str
    ライセンスキー

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
ライセンスキーの設定をする

===========================================================
>>> dsx.set_license("ライセンスキー")
0
===========================================================

Definition at line 2970 of file 1.DataServiceEx.py.

◆ setand()

def 1.DataServiceEx.setand (   self,
  table_name,
  src_setid,
  dst_setid 
)
2つのサブテーブル(セット)のAND抽出

Parameters
----------
table_name : str
    テーブル名        
src_setid : int
    対象セットID      
dst_setid : int
    ターゲットセットID

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
ルートセットかつ検索リスト(項目1=”あ”)のサブテーブルを抽出する

===============================================================================================================================================================
>>> dsx.get_tuple("practice1",1,20,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し'], ['3', '3', 'う', 'く', 'す']]
>>> dsx.search_values("practice1","項目1",1,["あ"])
2
>>> dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1] = 値リスト']]
>>> dsx.setand("practice1",1,2)
3
>>> dsx.get_tuple("practice1",1,50,3)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ']]
===============================================================================================================================================================

See Also
----------
1.テーブルデータ取得(get_tuple)で、抽出結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます。

Definition at line 2610 of file 1.DataServiceEx.py.

◆ setnot()

def 1.DataServiceEx.setnot (   self,
  table_name,
  setid 
)
サブテーブル(セット)のNOT抽出

Parameters
----------
table_name : str
    テーブル名
setid : int
    セットID  

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
テーブルpractice1のサブテーブル、検索リスト(項目1=”あ”)でないものをルートセットから抽出する

===============================================================================================================================================================
>>> dsx.get_tuple("practice1",1,20,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し'], ['3', '3', 'う', 'く', 'す']]
>>> dsx.search_values("practice1","項目1",1,["あ"])
2
>>> dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1] = 値リスト']]
>>> dsx.setnot("practice1",2)
4
>>> dsx.get_tuple("practice3",1,20,4)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '2', 'い', 'き', 'し'], ['2', '3', 'う', 'く', 'す']]
===============================================================================================================================================================

See Also
----------
1.テーブルデータ取得で、抽出結果確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます
3.NOT抽出とSUB抽出の違いについては、クッキングマニュアルのp.63をご参照ください

Definition at line 2870 of file 1.DataServiceEx.py.

◆ setor()

def 1.DataServiceEx.setor (   self,
  table_name,
  src_setid,
  dst_setid 
)
2つのサブテーブル(セット)のOR抽出

Parameters
----------
table_name : str
    テーブル名  
src_setid : int
    対象セットID
dst_setid : int
    ターゲットセットID

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
テーブルpractice1の2つのサブテーブル、検索リスト(項目1=”あ”)または検索リスト(項目2=”き”)を抽出する

===============================================================================================================================================================
>>>dsx.get_tuple("practice1",1,20,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し'], ['3', '3', 'う', 'く', 'す']]
>>>dsx.search_values("practice1","項目1",1,["あ"])
2
>>>dsx.search_values("practice1","項目2",1,["き"])
3
>>>dsx.get_setid_list("practice1")
[[1, ''], [2, 'Search Set:1 [項目1] = 値リスト']] , [3, 'Search Set:1 [項目2] = 値リスト']]
>>> dsx.setor("practice1",2,3)
4
>>> dsx.get_tuple("practice1",1,20,4)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し']]
===============================================================================================================================================================

See Also
----------
1.テーブルデータ取得(get_tuple)で、抽出結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 2918 of file 1.DataServiceEx.py.

◆ setsub()

def 1.DataServiceEx.setsub (   self,
  table_name,
  src_setid,
  dst_setid 
)
2つのサブテーブル(セット)のSUB抽出

Parameters
----------
table_name : str
    テーブル名  
src_setid : int
    対象セットID
dst_setid : int
    ターゲットセットID

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
テーブルpractice1の2つのサブテーブル、検索リスト(項目1=”あ”)を除いたテーブルから、 検索リスト(項目1=”い”)を除いたものを抽出する

===============================================================================================================================================================
>>>dsx.get_tuple("practice1",1,20,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し'], ['3', '3', 'う', 'く', 'す']]
>>>dsx.search_values("practice1","項目1",1,["あ"])
2
>>> dsx.setnot("practice1",2)
3
>>> dsx.get_tuple("practice3",1,20, 3)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '2', 'い', 'き', 'し'], ['2', '3', 'う', 'く', 'す']]
>>>dsx.search_values("practice1","項目1",1,["い"])
4
>>> dsx.setsub("practice1",3,4)
7
>>> dsx.get_tuple("practice1",1,20,7)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'う', 'く', 'す']]
===============================================================================================================================================================

See Also
----------
1.テーブルデータ取得(get_tuple)で、抽出結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます
3.NOT抽出とSUB抽出の違いについては、クッキングマニュアルのp.63をご参照ください

Definition at line 3001 of file 1.DataServiceEx.py.

◆ sort()

def 1.DataServiceEx.sort (   self,
  table_name,
  item_name,
  setid,
  sort_type = 'ASC' 
)
データのソート

Parameters
----------
table_name : str
    テーブル名
item_name : str
    項目名  
setid : int
    セットID
sort_type : str, default 'ASC'
    並び順(ASC:昇順、DSC:降順)

Returns
-------
ResultCode : int
    結果コード(正:生成されたセットID、負:エラーコード)

Examples
----------
項目1の値を昇順にする

==============================================================
>>> dsx.get_cell(“practice1”,”項目1”,1,5,1)
[‘2’,’3’,’4’,’5’,’1’]
>>> dsx.sort(“practice1”,”項目1”,1,”ASC”)
2
>>> dsx.get_cell(“practice1”,”項目1”,1,5,2)
[‘1’,’2’,’3’,’4’,’5’]
==============================================================

Notes
----------
ソートした際に生成されたセットIDが2なので、ソート結果確認のセルの値取得では引数(セットID)が2となります

See Also
----------
1.セルの値取得(get_cell)で、ソート結果を確認できます
2.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 3056 of file 1.DataServiceEx.py.

◆ sort_item()

def 1.DataServiceEx.sort_item (   self,
  table_name,
  sort_key 
)
項目の並び順をソート

Parameters
----------
table_name : str
    テーブル名
sort_key : str
    ソートキー(ID、TYPE、NAME)

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Examples
----------
項目の並びを名前順にする

===========================================================
>>> dsx.get_itemlist(“practice1”)
[‘項目2’,’項目3’,’項目1’]
>>> dsx.sort_item(“practice1”,”NAME”)
0
>>> dsx.get_itemlist(“practice1”)
[‘項目1’,’項目2’,’項目3’]
============================================================

See Also
----------
項目一覧取得(get_itemlist)で、ソート結果を確認できます

Definition at line 1301 of file 1.DataServiceEx.py.

◆ start_sdc3()

def 1.DataServiceEx.start_sdc3 (   self)
Jupyterから「SDC V3」を起動(限定公開機能)
JupyterとSDC V3でデータ処理エンジンを共用(お互いが処理したテーブルを参照・更新できる)


デスクトップタイプのみ動作可能(Jupyter notebook/labのセル中で使用すること)
PYTHONPATHでserverへのパス指定が必須です。

Jupyter lab 起動例
  cd ESPERiCフォルダーのパス
  export PYTHONPATH=$(cd "./server/dataService" && pwd):$PYTHONPATH
  export PYTHONPATH=$(cd "./server" && pwd):$PYTHONPATH
  export DYLD_LIBRARY_PATH=$(cd "./server/di5engine/mac" && pwd)  ←←← macOSの場合のみ 必須
  Jupyter Lab

使用上の注意
1. Jupyter側で作成したテーブル/セットをSDC V3側のワークスペース表示に反映させるには、SDC V3側でワークスペースの変更を伴う操作が必要です。
2. SDC V3側でログアウトするとJupyter側のPythonjカーネルが停止して、以後、操作できなくなります。
3. SDC V3側で参照しているテーブルをJupyter側で削除/変更すると、SDC V3側で予期せぬエラーが発生することがあります。


Parameters
----------
None

Returns
-------
None

Definition at line 3595 of file 1.DataServiceEx.py.

◆ transfer_item()

def 1.DataServiceEx.transfer_item (   self,
  table_name,
  item_name 
)
項目転送

Parameters
----------
table_name : str
    転送元JOINテーブル名
item_name : str
    項目名              

Returns
-------
ResultCode : int
    結果コード(正:追加作成された項目ID、負:エラーコード)

Examples
----------
テーブルpractice1とpractice2を内部結合(InnerJOIN)した後、項目1を転送する

=================================================================================================================================================================================================
>>> dsx.join("join1","practice1","practice2",1,1,["項目1"],["項目1"],"Inner","No")
3
>>> dsx.get_tuple("practice1",1,20,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', 'あ', 'か', 'さ'], ['2', '2', 'い', 'き', 'し'], ['3', '3', 'う', 'く', 'す']]
>>> dsx.transfer_item("join1","項目1")
12
>>> dsx.get_tuple("practice3",1,20,1)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3', '項目1_#1'], ['1', '1', 'あ', 'か', 'さ', 'ア'], ['2', '2', 'い', 'き', 'し', 'イ'], ['3', '3', 'う', 'く', 'す', 'ウ']]
=================================================================================================================================================================================================

See Also
----------
テーブルデータ取得(get_tuple)で、転送した項目を確認できます

Definition at line 1343 of file 1.DataServiceEx.py.

◆ union()

def 1.DataServiceEx.union (   self,
  table_name,
  master_table_name,
  slave_table_name,
  master_setid,
  slave_setid,
  master_union_key,
  slave_union_key,
  is_master_tableid = 'Yes',
  is_slave_rec_number = 'Yes',
  is_delete_table = 'No' 
)
ユニオン(テーブルの縦結合)

Parameters
----------
table_name : str
    縦結合テーブル名          
master_table_name : str
    マスターテーブル名        
slave_table_name : str
    スレーブテーブル名        
master_setid : int
    マスターテーブルのセットID
slave_setid : int
    スレーブテーブルのセットID
master_union_key : str
    マスターテーブルの結合キーリスト 
slave_union_key : str
    スレーブテーブルの結合キーリスト 
is_master_tableid : str
    Yes:マスターテーブルのIDを使用する、No:使用しない   
is_slave_rec_number : str
    Yes:スレーブテーブルのRecNoを出力する、No:出力しない
is_delete_table : str
    Yes:元テーブルを削除する、No:削除しない             

Returns
-------
ResultCode : int
    結果コード(正:生成されたテーブルID、負:エラーコード)

Examples
----------
テーブルpractice1とpractice2の項目1を結合する

=====================================================================================================================================================================================================================================================================
>>> dsx.get_tablelist()
['practice1', 'practice2']
>>> dsx.union("union1","practice1","practice2",1,1,["項目1"],["項目1"],"No","No","No")
4
>>> dsx.get_tablelist()
['practice1, 'practice2','union1']
>>> dsx.get_tuple("union1",1,50,1)
[['SeqNo', 'RecNo', '項目1'], ['1', '1', 'あ'], ['2', '2', 'い'], ['3', '3', 'う'], ['4', '4', 'え'], ['5', '5', 'お'], ['6', '6', 'ア'], ['7', '7', 'イ'], ['8', '8', 'ウ'], ['9', '9', 'エ'], ['10', '10', 'オ']]
=====================================================================================================================================================================================================================================================================

See Also
----------
1.テーブル一覧取得(get_tablelist)で、UNIONテーブルが追加されたことを確認できます
2.テーブルデータ取得(get_tuple)で、結合結果を確認できます
3.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 3306 of file 1.DataServiceEx.py.

◆ visible_item()

def 1.DataServiceEx.visible_item (   self,
  table_name,
  item_name,
  is_visibility = 'Yes' 
)
項目の表示/非表示

Parameters
----------
table_name : str
    テーブル名 
item_name : str
    項目名     
is_visibility : str, default 'Yes'
    表示/非表示(Yes/No)

Returns
-------
ResultCode : int
    結果コード(0:成功、負:エラーコード)

Definition at line 3376 of file 1.DataServiceEx.py.

◆ write_csv()

def 1.DataServiceEx.write_csv (   self,
  table_name,
  file_name,
  setid,
  delimiter = 'CSV',
  write_top = 1,
  write_bottom = -1,
  write_left = 1,
  write_right = -1,
  is_header = 'Yes' 
)
データのエクスポート

Parameters
----------
table_name : str
    テーブル名                  
file_name : str
    エクスポート先のファイル名                  
setid : int
    セットID                    
delimiter : str, default 'CSV'
    区切り文字(CSV/TAB)       
write_top : int, default 1
    開始行(先頭行は1)        
write_bottom : int, default -1
    終了行(マイナス値は最終行)
write_left : int, default 1
    開始列(先頭列は1、RecNoは指定不可)
write_right : int, default -1
    終了列(マイナス値は最終列)
is_header : str, default 'Yes'
    Yes:項目ヘッダー出力あり、No:項目ヘッダー出力なし

Returns
-------
ResultCode : int
    結果コード(正:出力行数、負:エラーコード)

Examples
----------
テーブルpractice1の全ての値をカンマ区切りのCSVファイルにエクスポートする

=============================================================================================================================
>>> dsx.write_csv(“practice1”,”フォルダ\\フォルダ\\フォルダ\\practice.csv”,1,”CSV”,1,-1,1,-1,”Yes”)
10
=============================================================================================================================

See Also
----------
セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 3109 of file 1.DataServiceEx.py.

◆ write_csv_selectitem()

def 1.DataServiceEx.write_csv_selectitem (   self,
  table_name,
  file_name,
  setid,
  delimiter = 'CSV',
  write_top = 1,
  write_bottom = -1,
  item_name_list = '*',
  is_header = 'Yes' 
)
項目名指定でデータのエクスポート

Parameters
----------
table_name : str
    テーブル名                  
file_name : str
    エクスポート先のファイル名                  
setid : int
    セットID                    
delimiter : str
    区切り文字(CSV/TAB)       
write_top : int, default 1
    開始行(先頭行は1)        
write_bottom : int, default -1
    終了行(マイナス値は最終行)
item_name_list : list, default '*'
    抽出項目名リスト("*"は全項目が対象)    
is_header : str, default 'Yes'
    Yes:項目ヘッダー出力あり、No:項目ヘッダー出力なし

Returns
-------
ResultCode : int
    結果コード(正:出力行数、負:エラーコード)

Examples
----------
テーブルpractice1の項目1のみをカンマ区切りのCSVファイルにエクスポートする

===============================================================================================================================================================
>>>dsx.write_csv_selectitem("practice1”,”フォルダ\\フォルダ\\フォルダ\\practice.csv",1,"CSV",1,-1,["項目1"],"Yes")
10
===============================================================================================================================================================

See Also
----------
セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 3169 of file 1.DataServiceEx.py.

◆ write_parquet()

def 1.DataServiceEx.write_parquet (   self,
  table_name,
  file_name,
  setid = -1,
  columns = None 
)
テーブルをParquet形式でエクスポート

※ pyarrow(Python Lib.)のインストールが必要です。

Parameters
----------
table_name : str
    テーブル名                  
file_name : str
    エクスポート先のファイル名 
setid : int, default -1
    セットID(省略した場合はカレントセット)
columns : list, default None
    抽出項目名リスト(省略時は全項目が対象)

Returns
-------
ResultCode : int
    結果コード(正:出力行数、負:エラーコード)

Definition at line 3560 of file 1.DataServiceEx.py.

◆ xsum()

def 1.DataServiceEx.xsum (   self,
  table_name,
  setid,
  dimension_item_list,
  measure_item_list 
)
データの集計

Parameters
----------
table_name : str
    テーブル名
setid : int
    セットID  
dimension_item_list : list
    次元の項目名リスト(最大32項目)
measure_item_list : list
    測度の項目リスト {項目名,件数,最大値,最小値,合計値,平均値}(最大32項目)
        件数  (Yes:集計する、No:集計しない)
        最大値(Yes:集計する、No:集計しない)
        最小値(Yes:集計する、No:集計しない)
        合計値(Yes:集計する、No:集計しない)
        平均値(Yes:集計する、No:集計しない)

Returns
-------
ResultCode : int
    結果コード(正:生成された集計テーブルID、負:エラーコード)

Examples
----------
項目1の件数、最大値、最小値、合計値、平均値を集計する

=============================================================================================================================================================================================================================================================================================================================================================================================================
>>> dsx.get_tuple("practice1",1,50,2)
[['SeqNo', 'RecNo', '項目1', '項目2', '項目3'], ['1', '1', '10', '20', '30'], ['2', '2', '9', '19', '29'], ['3', '3', '8', '18', '28'], ['4', '4', '7', '17', '27'], ['5', '5', '6', '16', '26']]
>>> dsx.xsum("practice1",1,["項目1"],[["項目1","Yes","Yes","Yes","Yes","Yes"]])
5
>>> dsx.get_tablelist()
['practice1', 'XTBL_practice1']
>>> dsx.get_tuple("XTBL_practice1",1,50,1)
[['SeqNo', 'RecNo', '項目1', 'N<項目1>', 'MAX<項目1>', 'MIN<項目1>', 'SUM<項目1>', 'AVG<項 目1>'], ['1', '1', '1', '1', '1', '1', '1.000', '1.000'], ['2', '2', '2', '1', '2', '2', '2.000', '2.000'], ['3', '3', '3', '1', '3', '3', '3.000', '3.000'], ['4', '4', '4', '1', '4', '4', '4.000', '4.000'], ['5', '5', '5', '1', '5', '5', '5.000', '5.000']]
=============================================================================================================================================================================================================================================================================================================================================================================================================

Notes
----------
引数の、測度の項目リストの角カッコ[ ]は二重である点に注意してください

See Also
----------
1.テーブル一覧取得(get_tablelist)で、集計テーブルが追加されたことを確認できます
2.テーブルデータ取得(get_tuple)で、集計結果を確認できます
3.セットIDが分からない時は、セットID一覧取得(get_setid_list)で確認できます

Definition at line 3403 of file 1.DataServiceEx.py.

Property Documentation

◆ LastMessage

1.DataServiceEx.LastMessage = property(fget=__get_message, fset=__set_message)
static

Definition at line 61 of file 1.DataServiceEx.py.


The documentation for this class was generated from the following file: