query()

指定のオブジェクトに対してクエリを実行して、指定の条件に一致したデータを返します。

呼び出し時に、API は特定のオブジェクトに対するクエリを実行し、API 上のクエリの結果をキャッシュし、クエリレスポンスオブジェクトをクライアントアプリケーションに返します。それから、クライアントアプリケーションは、クエリレスポンスの行を通して反復し、情報を取得するために、クエリレスポンスオブジェクト上のメソッドを使用できます。

オブジェクト内で個々のオブジェクトを照会したり、項目リスト内で項目を照会したりするには、適切なアクセス権でクライアントアプリケーションにログインする必要があります。詳細は、「データアクセスに影響する要素」を参照してください。

いくつかのオブジェクトは、API 経由でクエリを実行できません。query() コールを介してオブジェクトを照会するには、オブジェクトがクエリ可能に設定されている必要があります。クエリ可能かどうかを判断するために、クライアントアプリケーションは、オブジェクト上の describeSObjects() コールを呼び出すことができ、queryable プロパティを確認できます。

アーカイブされているかどうかにかかわらず、すべての ToDo と行動のレコード上では、queryAll() でクエリを実行できます。アーカイブ済みのオブジェクトのみを検索するには、isArchived 項目を絞り込みに利用できます。query() は、isArchived が true に設定されている場合、すべてのレコードを自動的に除外するため、query() は使用できません。アーカイブ済みのレコードの挿入、更新、または削除も可能です。

クエリ結果のオブジェクトには、デフォルトで、最大 500 行のデータが含まれます。クエリ結果が 500 行を超える場合、クライアントアプリケーションは queryMore() コールとサーバ側のカーソルを使用して、追加の行を 500 行のチャンクで取得します。QueryOptions ヘッダーのデフォルトサイズを最大 2,000 行に増やすことができます。詳細は、『SOQL および SOSL リファレンス』の「クエリのバッチサイズの変更」を参照してください。

処理が 2 分以上経過したクエリは、タイムアウトします。タイムアウトしたクエリに関しては、API は、InvalidQueryLocatorFault の API 失敗エラー要素を返します。タイムアウトが発生した場合は、より少量のデータをスキャンするか、クエリを再構成します。

型が Base64 の項目について (「base64」参照) 照会する場合には、クエリレスポンスオブジェクトは、一度に 1 つのレコードしか返しません。query() コールのバッチサイズを変更しても、これを変更することはできません。