【memcache/redis】memcache常用函式集彙總
Memcache::add – 新增一個值,如果已經存在,則返回false
Memcache::addServer – 新增一個可供使用的伺服器地址
Memcache::close – 關閉一個Memcache物件
Memcache::connect – 建立一個Memcache物件
memcache_debug – 控制除錯功能
Memcache::decrement – 對儲存的某個key中的值進行減法操作
Memcache::delete – 刪除一個key值
Memcache::flush – 清除所有快取的資料
Memcache::get – 獲取一個key值
Memcache::getExtendedStats – 獲取程序池中所有程序的執行系統統計
Memcache::getServerStatus – 獲取執行伺服器的引數
Memcache::getStats – 返回伺服器的一些執行統計資訊
Memcache::getVersion – 返回執行的Memcache的版本資訊
Memcache::increment – 對儲存的某個key中的值進行加法操作
Memcache::pconnect – 建立一個Memcache的持久連線物件
Memcache::replace -對一個已有的key進行覆寫操作
Memcache::set – 新增一個值,如果已經存在,則覆寫
Memcache::setCompressThreshold – 對大於某一大小的資料進行壓縮
Memcache::setServerParams – 在執行時修改伺服器的引數
Memcache::add用法
bool Memcache::add ( string$key,mixed$var [, int $flag [, int $expire ]] )說明:
如果$key不存在的時候,使用這個函式來儲存$var的值。功能相同的函式是memcache_add()。
引數:
$key :將要儲存的鍵值。
$var :儲存的值,字元型和整型會按原值儲存,其他型別自動序列化以後儲存。
$flag:是否用MEMCACHE_COMPRESSED來壓縮儲存的值,true表示壓縮,false表示不壓縮。
$expire:儲存值的過期時間,如果為0表示不會過期,你可以用unix時間戳或者描述來表示從現在開始的時間,但是你在使用秒數表示的時候,不要超過2592000秒 (表示30天)。
返回值:
如果成功則返回 TRUE,失敗則返回 FALSE。如果$key值已經存在,則會返回FALSE。 其他情況下Memcache::add()的用法類似於Memcache::set()。
例子:
<?php$memcache_obj= memcache_connect(”localhost”,11211);
memcache_add($memcache_obj, ’var_key’, ’test variable’,false,30);
$memcache_obj->add(’var_key’, ’test variable’,false,30);
?>
Memcache::addServer用法
bool Memcache::addServer ( string $host [, int $port [, bool $persistent [, int $weight [, int$timeout [, int $retry_interval [, bool $status [, callback $failure_callback ]]]]]]] )說明:
新增一個可供使用的伺服器地址到連線池中,連線用Memcache::addServer開啟,指令碼執行完後自動關閉,或者可以用Memcache::close()手動關閉。相同函式是memcache_add_server()。
當用這個方法的時候(相對於Memcache::connect()和 Memcache::pconnect()方法),網路連線只有等需要的時候才會建立,因此不會因為增加很多的伺服器到連線池而增加系統負擔,因為很多伺服器可能沒有使用。
故障恢復會發生在這個方法執行的任何階段,只要其他的伺服器是正常的,這些連線請求的失敗使用者不會注意到。任何一種socket或者memcached伺服器級的錯誤可以觸發故障恢復。正常的客戶端錯誤比如增加一個存在的鍵值不會引發故障恢復。
引數:
$host伺服器的地址
$port伺服器埠
$persistent是否是一個持久連線
$weight這臺伺服器在所有伺服器中所佔的權重
$timeout連線的持續時間
$retry_interval連線重試的間隔時間,預設為15,設定為-1表示不進行重試
$status控制伺服器的線上狀態
$failure_callback允許設定一個回掉函式來處理錯誤資訊。
返回值:
如果成功則返回 TRUE,失敗則返回 FALSE。
例子:
<?php$memcache=new Memcache;
$memcache->addServer(’memcache_host’,11211);
$memcache->addServer(’memcache_host2′,11211);
$memcache_obj= memcache_connect(’memcache_host’,11211);
memcache_add_server($memcache_obj, ’memcache_host2′,11211);
?>
Memcache::close用法
bool Memcache::close ( void )說明:
關閉memcache伺服器連線。這個函式不會關閉長連線,長連線只有在web伺服器關閉或者重啟的時候才會關閉。相同的函式memcache_close()
返回值:
如果成功則返回 TRUE,失敗則返回 FALSE。
例子:
<?php$memcache_obj= memcache_connect(’memcache_host’,11211);
memcache_close($memcache_obj);
$memcache_obj=new Memcache;
$memcache_obj->connect(’memcache_host’,11211);
$memcache_obj->close();
?>
Memcache::connect用法
bool Memcache::connect ( string$host [, int $port [, int $timeout ]] )說明:
開啟memcached伺服器連線,建立一個到memcached伺服器的連線,用Memcache::connect開啟的連線會在指令碼執行完畢後自動關閉。你也可以用Memcache::close()去關閉連線。相同的函式是memcache_connect()。
引數:
$host:指向memcached正在收聽的連結的主機,這個引數會有另一種特殊的連線方式unix:///path/to/memcached.sock,即用unix的域名sockets,這種情況下,埠必須設定為0
$port:指向memcached正在收聽的連結的埠,用unix的域名sockets的情況下,埠必須設定為0
$timeout:用於連線守護程序的秒數,當你改變預設的1秒的值的時候,你需要考慮一下,如果你的連線太慢的話,你可能會失去快取的優勢。
返回值:
如果成功則返回 TRUE,失敗則返回 FALSE。
例子:
<?php$memcache_obj= memcache_connect(’memcache_host’,11211);
$memcache=new Memcache;
$memcache->connect(’memcache_host’,11211);
?>
memcache::debug
bool memcache_debug ( bool $on_off )說明:
控制除錯功能,前提是php在編譯的時候使用了-enable-debug選項,否則這個函式不會有作用。
引數:
$on_off:true表示開啟除錯,false表示關閉除錯
返回值:
如果php在編譯的時候使用了-enable-debug選項,返回true,否則返回false
Memcache::decrement用法
int Memcache::decrement ( string$key [, int $value ] )說明:
Memcache::decremen方法的作用是對儲存的某個key中的值進行減法操作,用法跟Memcache::increment類似。
你也可以用memcache_decrement()函式。
引數:
Key:想要減少的鍵的名字
Value:想要減少的值。
返回值:
如果成功,返回被減少後的值,如果失敗返回false。
例子:
<?php$memcache=new Memcache;
$memcache->connect(’localhost’,11211);
$memcache->set(’test_item’,8);
$memcache->increment(’test_item’,4);
echo$memcache->decrement(’test_item’,7);
// 顯示 5?>
這個例子連Memcache::increment函式都一塊演示了。
Memcache::delete用法
bool Memcache::delete ( string$key [, int $timeout ] )說明:
刪除一個key值,如果引數$timeout被設定,那麼儲存的值會在設定的秒數以後過期,你也可以用函式memcache_delete()
返回值:
如果成功則返回 TRUE,失敗則返回 FALSE。
例子:
<?php$memcache_obj= memcache_connect(’memcache_host’,11211);
memcache_delete($memcache_obj, ’key_to_delete’,10);
$memcache_obj=new Memcache;
$memcache_obj->connect(’memcache_host’,11211);
$memcache_obj->delete(’key_to_delete’,10);
?>
Memcache::flush
bool Memcache::flush ( void )說明:
清除所有快取的資料。Memcache::flush實際上沒有釋放資源,它僅僅將所有的快取標記為過期,這樣可以使新的快取來覆蓋被佔的記憶體空間。一樣的函式是memcache_flush()
返回值:
如果成功則返回 TRUE,失敗則返回 FALSE。
例子:
<?php$memcache_obj= memcache_connect(’memcache_host’,11211);
memcache_flush($memcache_obj);
$memcache_obj=new Memcache;
$memcache_obj->connect(’memcache_host’,11211);
$memcache_obj->flush();
?>
Memcache::get
string Memcache::get ( string$key [, int &$flags ] )array Memcache::get ( array$keys [,array&$flags ] )
說明:
方法的作用是獲取一個key值,key值可以是一個數組,結果會包含鍵值對。
引數:
$key是鍵值或者一個鍵的陣列值。
$flags如果這個引數存在,那麼$flags跟寫入這個引數的值相關,這些$flags 類似於Memcache::set()函式裡的$flags。
返回值:
如果成功,則返回key對應的值,如果失敗則返回false.
例子:
<?php$memcache_obj= memcache_connect(’memcache_host’,11211);
$var= memcache_get($memcache_obj, ’some_key’);
$memcache_obj=new Memcache;
$memcache_obj->connect(’memcache_host’,11211);
$var=$memcache_obj->get(’some_key’);
$memcache_obj= memcache_connect(’memcache_host’,11211);
$var= memcache_get($memcache_obj,Array(’some_key’, ’another_key’));
$memcache_obj=new Memcache;
$memcache_obj->connect(’memcache_host’,11211);
$var=$memcache_obj->get(Array(’some_key’, ’second_key’));
?>
Memcache::getExtendedStats
array Memcache::getExtendedStats ([ string$type [, int $slabid [, int $limit ]]] )說明:
獲取程序池中所有程序的執行系統統計。相同函式是memcache_get_extended_stats()
引數:
$type表示要求返回的型別:reset, malloc, maps, cachedump, slabs, items, sizes;
$slabid第一個引數設定為”cachedump”時使用的。
$limit第一個引數設定為”cachedump”時使用的。
返回值:
如果成功,返回統計資訊,失敗會返回false
例子:
<?php$memcache_obj=new Memcache;
$memcache_obj->addServer(’memcache_host’,11211);
$memcache_obj->addServer(’failed_host’,11211);
$stats=$memcache_obj->getExtendedStats();
//slabs機制分配管理記憶體的情況$statsslab=$memcache_obj->getExtendedStats(slabs);
?>
Memcache::getServerStatus
int Memcache::getServerStatus ( string$host [, int $port ] )說明:
獲取執行伺服器的引數。返回一個伺服器線上或者離線的狀態。相同的函式是memcache_get_server_status()
引數:
$host:正在收聽的連線的主機
$port正在收聽的連線的主機的埠,預設是11211
返回值:
成功返回伺服器狀態,伺服器沒有啟動會返回0,其他數字的時候表示伺服器是啟動狀態的。
例子:
<?php$memcache=new Memcache;
$memcache->addServer(’memcache_host’,11211);
echo$memcache->getServerStatus(’memcache_host’,11211);
$memcache= memcache_connect(’memcache_host’,11211);
echo memcache_get_server_status($memcache, ’memcache_host’,11211);
?>
Memcache::getStats
array Memcache::getStats ([ string$type [, int $slabid [, int $limit ]]] )說明:
返回伺服器的一些執行統計資訊。相同的函式是memcache_get_stats()
引數:
$type表示要求返回的型別:reset, malloc, maps, cachedump, slabs, items, sizes;
$slabid第一個引數設定為”cachedump”時使用的。
$limit第一個引數設定為”cachedump”時使用的。
Memcache::getVersion
string Memcache::getVersion ( void )說明:
返回執行的Memcache的版本資訊。相同函式memcache_get_version()
返回值:
成功返回伺服器的版本資訊,失敗的時候返回false。
例子:
<?php$memcache=new Memcache;
$memcache->connect('memcache_host',11211);
echo$memcache->getVersion();
$memcache= memcache_connect('memcache_host',11211);
echo memcache_get_version($memcache);
?>
Memcache::increment
int Memcache::increment ( string$key [, int $value ] )對儲存的某個key中的值進行加法操作
用法參考Memcache::decrement
Memcache::pconnect
bool Memcache::pconnect ( string$host [, int $port [, int $timeout ]] )說明:
建立一個Memcache的持久連線物件
用法與Memcache::connect()相似,不同點地方是Memcache::pconnect是建立的持久連線。這個連線在指令碼執行完或者Memcache::close()函式執行也不會被關閉。與它相同的函式是memcache_pconnect()
引數:
$host:指向memcached正在收聽的連結的主機,這個引數會有另一種特殊的連線方式unix:///path/to/memcached.sock,即用unix的域名sockets,這種情況下,埠必須設定為0
$port:指向memcached正在收聽的連結的埠,用unix的域名sockets的情況下,埠必須設定為0
$timeout:用於連線守護程序的秒數,當你改變預設的1秒的值的時候,你需要考慮一下,如果你的連線太慢的話,你可能會失去快取的優勢。
返回值:
如果成功則返回 TRUE,失敗則返回 FALSE
<?php$memcache_obj= memcache_pconnect('memcache_host',11211);
$memcache_obj= new Memcache;
$memcache_obj->pconnect('memcache_host',11211);
?>
Memcache::replace
bool Memcache::replace ( string$key,mixed$var [, int $flag [, int $expire ]] )說明:
對一個已有的key進行覆寫操作。相同函式是memcache_replace()
引數: