k2hdkcのドキュメントへようこそ

k2hdkc_python

https://img.shields.io/pypi/pyversions/k2hdkc.svg

https://img.shields.io/github/forks/yahoojapan/k2hdkc_python.svg

https://img.shields.io/github/stars/yahoojapan/k2hdkc_python.svg

https://img.shields.io/github/issues/yahoojapan/k2hdkc_python.svg

https://readthedocs.org/projects/k2hdkc-python/badge/?version=latest

概要

k2hdkc_pythonは、k2hdkc のPython版（公式）です。

https://raw.githubusercontent.com/yahoojapan/k2hdkc_python/main/docs/images/top_k2hdkc_python.png

インストール

pipコマンドを使って、k2hdkcのPython版をインストールしましょう。

pip install k2hdkc

使い方

最初に、k2hdkcの共有ライブラリをインストールしなければなりません。

$ curl -o- https://raw.github.com/yahoojapan/k2hdkc_python/master/cluster/start_server.sh | bash

Then, Let's try to set a key and get it:

import k2hdkc

k = k2hdkc.K2hdkc('slave.yaml')
k.set('hello', 'world')
v = k.get('hello')
print(v)    // world

開発

このレポジトリをクローンして、以下のコマンドを打ち込んでください。

$ python3 -m pip install --upgrade build
$ python3 -m build

ドキュメント

k2hdkcのPython版以外のコンポーネントのドキュメントはこちらです。

ドキュメントトップ

K2HDKCについて

AntPickaxについて

パッケージについて

この他のコンポーネントのパッケージはこちらです。

k2hdkc(python packages)

ライセンス

MITライセンスです。詳しくは、LICENSEファイルを見てください。

AntPickax

k2hdkc_pythonは、 AntPickax によるプロジェクトの一つです。 AntPickax は、ヤフー株式会社のオープンソース開発チームの一つです。

k2hdkc

k2hdkcパッケージ

サブモジュール

k2hdkc.k2hdkc module

K2hdkc Python Driver

class k2hdkc.k2hdkc.K2hdkc(conf_file, port=8031, cuk=None, rejoin=True, rejoin_forever=True, clear_backup=True)

ベースクラス: object

K2hdkcクラスはk2hdkcハッシュデータベースのkey/valueペアを操作するメソッドを提供します。

K2H_INVALID_HANDLE = 0

add_subkey(key, subkey, subval, check_attr=True, password=None, expire_duration=None, time_unit=TimeUnit.SECONDS): サブキーを追加します。

cas_decrement(key, password=None, expire_duration=None): CAS操作によって、値を一つ減じます。

cas_get(key, data_type, password=None, expire_duration=None): CAS操作によって、値を取得します。

cas_increment(key, password=None, expire_duration=None): CAS操作によって、値を一つ足します。

cas_init(key, val=None, password=None, expire_duration=None): CAS操作によって、値を初期化します。

cas_set(key, old_val, new_val, password=None, expire_duration=None): CAS操作によって、値をセットします。

clear_subkeys(key): サブキーを削除します。

close(): 接続を閉じます。

get(key, password=None): 値を取得します。

get_attributes(key, use_str=True): キーの属性を取得します。

get_subkeys(key, use_str=True): キーのサブキーを取得します。

keyqueue_get(prefix, is_fifo=True, password=None, expire_duration=None): キューからキーと値のセットを取得します。

keyqueue_put(prefix, key, val, is_fifo=True, is_check_attr=True, password=None, expire_duration=None): キューにキーと値のセットを追加します。

property libc: libcライブラリハンドルを返します。

property libk2hdkc: returns libk2hkc handle

queue_get(prefix, is_fifo=True, password=None, expire_duration=None): キューの要素を取得します。

queue_put(prefix, val, is_fifo=True, is_check_attr=True, password=None, expire_duration=None): キューに要素を追加します。

remove(key): キーを削除します。

remove_subkeys(key, subkeys, nested=False): サブキーを削除します。

rename(key, newkey, parent_key=None, is_check_attr=True, password=None, expire_duration=None): キーの名前を変えます。

set(key, val, clear_subkeys=False, subkeys=None, password=None, expire_duration=None, time_unit=TimeUnit.SECONDS): キーと値をセットします。

set_subkeys(key, subkeys): サブキーをセットします。

モジュール

k2hdkcパッケージ

class k2hdkc.K2hdkc(conf_file, port=8031, cuk=None, rejoin=True, rejoin_forever=True, clear_backup=True)

ベースクラス: object

K2hdkcクラスはk2hdkcハッシュデータベースのkey/valueペアを操作するメソッドを提供します。

K2H_INVALID_HANDLE = 0

add_subkey(key, subkey, subval, check_attr=True, password=None, expire_duration=None, time_unit=TimeUnit.SECONDS): サブキーを追加します。

cas_decrement(key, password=None, expire_duration=None): CAS操作によって、値を一つ減じます。

cas_get(key, data_type, password=None, expire_duration=None): CAS操作によって、値を取得します。

cas_increment(key, password=None, expire_duration=None): CAS操作によって、値を一つ足します。

cas_init(key, val=None, password=None, expire_duration=None): CAS操作によって、値を初期化します。

cas_set(key, old_val, new_val, password=None, expire_duration=None): CAS操作によって、値をセットします。

clear_subkeys(key): サブキーを削除します。

close(): 接続を閉じます。

get(key, password=None): 値を取得します。

get_attributes(key, use_str=True): キーの属性を取得します。

get_subkeys(key, use_str=True): キーのサブキーを取得します。

keyqueue_get(prefix, is_fifo=True, password=None, expire_duration=None): キューからキーと値のセットを取得します。

keyqueue_put(prefix, key, val, is_fifo=True, is_check_attr=True, password=None, expire_duration=None): キューにキーと値のセットを追加します。

property libc: libcライブラリハンドルを返します。

property libk2hdkc: returns libk2hkc handle

queue_get(prefix, is_fifo=True, password=None, expire_duration=None): キューの要素を取得します。

queue_put(prefix, val, is_fifo=True, is_check_attr=True, password=None, expire_duration=None): キューに要素を追加します。

remove(key): キーを削除します。

remove_subkeys(key, subkeys, nested=False): サブキーを削除します。

rename(key, newkey, parent_key=None, is_check_attr=True, password=None, expire_duration=None): キーの名前を変えます。

set(key, val, clear_subkeys=False, subkeys=None, password=None, expire_duration=None, time_unit=TimeUnit.SECONDS): キーと値をセットします。

set_subkeys(key, subkeys): サブキーをセットします。

功績

開発者

若林大崇

貢献者

中谷武史

歴史

1.0.0 (2022-02-07)

最初のリリース

一覧

索引
モジュール索引
検索ページ