This topic describes how to use Log Service SDK for PHP to use the Dedicated SQL feature.

Prerequisites

Log Service SDK for PHP of the latest version is installed. For more information, see Install Log Service SDK for PHP.

Background information

Log Service provides the Dedicated SQL feature to enhance SQL analysis capabilities. You can use this feature to process hundreds of billions of rows of data. For more information, see Enable Dedicated SQL.
Log Service provides the Aliyun_Log_Models_LogStoreSqlRequest and Aliyun_Log_Models_ProjectSqlRequest operations. You can call these operations to use the Dedicated SQL feature in an efficient manner.
  • Aliyun_Log_Models_LogStoreSqlRequest: uses the Dedicated SQL feature in a specified Logstore. This API operation supports the SQL-92 syntax. A query statement is in the Search statement|Analytic statement format and the analytic statement follows the standard SQL-92 syntax.
  • Aliyun_Log_Models_ProjectSqlRequest: uses the Dedicated SQL feature in a specified project. This API operation supports the SQL-92 syntax. You must specify a filter condition and time range in the WHERE clause of an SQL statement.
Note If you want to filter data before you analyze the data, we recommend that you call the Aliyun_Log_Models_LogStoreSqlRequest operation and specify a query statement that is in the Search statement|Analytic statement format. This improves analysis efficiency.

Sample code

The following sample code shows how to use the Dedicated SQL feature. For more information, see Alibaba Cloud Log Service SDK for PHP.

// The endpoint of Log Service. For more information, see Endpoints. In this example, the endpoint of the China (Hangzhou) region is used. Replace the parameter value with the actual endpoint. 
$endpoint = 'cn-hangzhou.log.aliyuncs.com';
// The AccessKey pair that is used to access Log Service. For more information, see AccessKey pair. An Alibaba Cloud account has permissions to call all API operations. If you use the AccessKey pair of your Alibaba Cloud account, your resources are exposed to high security risks. We recommend that you log on as a RAM user that has permissions to call API operations or perform routine O&M tasks. 
$accessKeyId = 'your_access_id';
$accessKey = 'your_access_key';
// The name of the project. 
$project = 'aliyun-test-project';
// The name of the Logstore. 
$logstore = 'aliyun-test-logstore';
// The Security Token Service (STS) token. For more information, see AssumeRole. 
$token = "your_token";
// Create a Log Service client. 
$client = new Aliyun_Log_Client($endpoint, $accessKeyId, $accessKey,$token);

// Execute an SQL statement in the specified Logstore.   
$from = time()-3600;
$to = time();
$query = "* | select count(method)";
$request = new Aliyun_Log_Models_LogStoreSqlRequest($project,$logstore,$from,$to,$query,true);
 
try {
   $response = $client->executeLogStoreSql($request);
   foreach($response -> getLogs() as $log)
   {   
       print $log -> getTime()."\t";
       foreach($log -> getContents() as $key => $value){
           print $key.":".$value."\t";
       }   
       print "\n";
    } 
   // Print the statistics of the analysis result. 
   // The number of rows of log data that is processed. 
    print "proccesedRows:".$response -> getProcessedRows()."\n";
    // The time that is required to execute the SQL statement. 
    print "elapsedMilli:".$response -> getElapsedMilli()."\n";
    // The CPU time that is consumed to execute the SQL statement after the Dedicated SQL feature is enabled. Unit: seconds. You are charged for the CPU time that is consumed when you use the Dedicated SQL feature to perform query and analysis operations. For more information, see Billable items. 
    print "cpuSec:".$response -> getCpuSec()."\n";
    // The number of CPU cores that are used to execute the SQL statement after the Dedicated SQL feature is enabled. 
    print "cpuCores:".$response -> getCpuCores()."\n";

} catch (Aliyun_Log_Exception $ex) {
 logVarDump($ex);
} catch (Exception $ex) {
 logVarDump($ex);
}   

// Execute an SQL statement in the specified project. 
$query = "select count(method) from sls_operation_log where __time__ > to_unixtime(now()) - 300 and __time__ < to_unixtime(now())";
$request = new Aliyun_Log_Models_ProjectSqlRequest($project,$query,True);   
try {
    $response = $client->executeProjectSql($request);
  #$response = $client->getProjectLogs($request);
  foreach($response -> getLogs() as $log)
  {
      print $log -> getTime()."\t";
      foreach($log -> getContents() as $key => $value){
          print $key.":".$value."\t";
      }
      print "\n";
  }
  // Print the statistics of the analysis result. 
  // The number of rows of log data that is processed. 
  print "proccesedRows:".$response -> getProcessedRows()."\n";
  // The time that is required to execute the SQL statement. 
  print "elapsedMilli:".$response -> getElapsedMilli()."\n";
  // The CPU time that is consumed to execute the SQL statement after the Dedicated SQL feature is enabled. Unit: seconds. You are charged for the CPU time that is consumed when you use the Dedicated SQL feature to perform query and analysis operations. For more information, see Billable items. 
  print "cpuSec:".$response -> getCpuSec()."\n";
  // The number of CPU cores that are used to execute the SQL statement after the Dedicated SQL feature is enabled. 
  print "cpuCores:".$response -> getCpuCores()."\n";
  print "requestId:".$response ->getRequestId()."\n";

} catch (Aliyun_Log_Exception $ex) {
 logVarDump($ex);
} catch (Exception $ex) {
   logVarDump($ex);
}
  • Aliyun_Log_Models_LogStoreSqlRequest operation
    You can call the Aliyun_Log_Models_LogStoreSqlRequest operation to use the Dedicated SQL feature. Requests must be in the following format:
    $from = time()-3600;
    $to = time();
    $query = "* | select count(method)";
    $request = new Aliyun_Log_Models_LogStoreSqlRequest($project,$logstore,$from,$to,$query,$powerSql);
    The following table describes the request parameters.
    Parameter Type Required Example Description
    $project String Yes N/A The name of the project.

    When you create a Log Service client, you must specify a value for the $project. Therefore, you do not need to set the parameter again.

    $logstore String Yes N/A The name of the Logstore.

    When you create a Log Service client, you must specify a value for the $logstore parameter. Therefore, you do not need to set the parameter again.

    $from Long Yes time()-3600 The start time of the time range that is specified in the request. The start time is a timestamp that follows the UNIX time format. It is the number of seconds that have elapsed since 00:00:00 UTC, Thursday, January 1, 1970.
    $to Long Yes time() The end time of the time range that is specified in the request. The end time is a timestamp that follows the UNIX time format. It is the number of seconds that have elapsed since 00:00:00 UTC, Thursday, January 1, 1970.
    $query String Yes "* | select count(method)" The query statement. Format: Search statement|Analytic statement. For more information, see Syntax.

    By default, Log Service returns 100 rows of data. You can use a LIMIT clause to specify the number of rows of data to return. For more information, see LIMIT syntax.

    $powerSql Boolean No true Specifies whether to use the Dedicated SQL feature. For more information, see Enable Dedicated SQL.
    • true: The Dedicated SQL feature is used.
    • false: The Standard SQL feature is used. This is the default value.
  • Aliyun_Log_Models_ProjectSqlRequest operation
    You can call the Aliyun_Log_Models_ProjectSqlRequest operation to use the Dedicated SQL feature. Requests must be in the following format:
    $query = "select count(method) from sls_operation_log where __time__ > to_unixtime(now()) - 300 and __time__ < to_unixtime(now())";
    $request = new Aliyun_Log_Models_ProjectSqlRequest($project,$query,$powerSql);   
    The following table describes the request parameters.
    Parameter Type Required Example Description
    $project String Yes N/A The name of the project.

    When you create a Log Service client, you must specify a value for the $project. Therefore, you do not need to set the parameter again.

    $query String Yes " select count(method) from sls_operation_log where __time__ > to_unixtime(now()) - 300 and __time__ < to_unixtime(now())" An SQL statement in which a filter condition and time range must be specified in the WHERE clause.

    By default, Log Service returns 100 rows of data. You can use a LIMIT clause to specify the number of rows of data to return. For more information, see LIMIT syntax.

    $powerSql Boolean No true Specifies whether to use the Dedicated SQL feature. For more information, see Enable Dedicated SQL.
    • true: The Dedicated SQL feature is used.
    • false: The Standard SQL feature is used. This is the default value.