Navigation: Schema: DocumentCloud > Tables

documents_search: DocumentCloud Search Document

Catalog: DocumentCloud

Schema: DocumentCloud

Primary Keys: id

Label: Search Document

This is a read-only table function. The DocumentCloud API may not support changing the data or the Invantive SQL driver for DocumentCloud does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the DocumentCloud API.

Select DocumentCloud API URL: /documents/search?q={query}&sections=false&annotations=false&data=false&mentions=false

Insert DocumentCloud API URL: /documents/search?q={query}&sections=false&annotations=false&data=false&mentions=false

Update DocumentCloud API URL: /documents/search?q={query}&sections=false&annotations=false&data=false&mentions=false

Delete DocumentCloud API URL: /documents/search?q={query}&sections=false&annotations=false&data=false&mentions=false

Field Selection Method: NotRequired

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function documents_search. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Default Value	Documentation
query	string	☑		Search query in terms by Solr. See also https://www.documentcloud.org/help/search/.

Table Function Columns

The columns of the table function documents_search are shown below. Each column has an SQL data type.

Name	Data Type	Required	Documentation
access	string	☐	The access level for the document. Defaults to 'private'.
asset_url	string	☐	The base URL to load this document’s static assets from.
canonical_url	string	☐	The canonical URL to view this document.
created_at	datetime	☐	Time stamp when this document was created.
description	string	☐	A brief description of the document.
edit_access	boolean	☑	Does the current user have edit access to this document.
file_hash	string	☐	File hash.
file_url	string	☐	A URL to a publicly accessible document for the URL Upload Flow.
force_ocr	boolean	☐	Force OCR even if the PDF contains embedded text - only include if file_url is set, otherwise should set force_ocr on the call to the processing endpoint.
id	int64	☑	The ID for the document.
language	string	☐	The language the document is in. Defaults to 'eng'.
organization	int64	☑	The ID for the organization this document belongs to.
original_extension	string	☐	Original file extension.
page_count	int32	☐	The number of pages in this document.
page_spec	string	☐	The dimensions for all pages in the document.
presigned_url	string	☐	The pre-signed URL to directly PUT the PDF file to.
publish_at	datetime	☐	A timestamp when to automatically make this document public.
published_url	string	☐	The URL where this document is embedded.
related_article	string	☐	The URL for the article about this document.
slug	string	☐	The slug is a URL safe version of the title.
source	string	☐	The source who produced the document.
status	string	☐	The status for the document.
title	string	☐	The document's title.
updated_at	datetime	☐	Time stamp when the document was last updated.
user	int64	☑	The ID for the user this document belongs to.

15-06-2022 21:30 Version 22.0.232-PROD+3445

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Document Cloud Data Model

documents_search: DocumentCloud Search Document

Parameters of Table Function

Table Function Columns

Important Safety and Usage Information