Adding a Connection to Google Search

To add a connection to Google Search:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Google Search icon is not available, click the Add More icon to download and install the Google Search connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Google Search

Provide the following connection properties before adding the authentication properties.

• CustomSearchId: Obtain this value by signing into Google Custom Search Engine and creating a new search engine.
• APIKey: You must enable the Custom Search API in the Google API Console.

For more information on obtaining values for these properties, refer to Connecting to Google Search.

To establish a connection to Google Search provide a CustomSearchId and APIKey.

Creating a Custom Search Engine

To start searching websites through the Sync App, follow the steps below:

1. Sign into the Google Custom Search Engine site.
2. Click New Search Engine and add a site to focus the search on.
3. Click Edit Seach Engine, select your search engine in the menu, and then click Setup.
4. In the Details section, click Search Engine Id to retrieve the search engine Id used as the CustomSearchId in the connection string.
5. In the Sites to Search section, you can additionally select the Search the Entire Web but Emphasize Included Sites option in the menu.

Getting the API Key

To authenticate requests to the Custom Search API, follow the steps below:

1. Log into the Google API console and select a project.
2. In the side bar under APIs & Services, click Library and then select the Custom Search API. Click Enable.
3. In the side bar, click APIs & Services -> Credentials.
4. Click Create Credentials -> API Key.
5. Select the API Key to restrict the key to your platform.

You can now search the Web using the Google Custom Search engine.

This section details a selection of advanced features of the Google Search Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Google Search and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models Google Custom Search engines as relational databases, which can be accessed with SQL-based tools.

This chapter describes the view behavior and provides examples of how to execute queries to Google Custom Search engines. Views are tables that cannot be modified. Typically, read-only data are shown as views. View schemas are defined in simple, text-based configuration files.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Google Search Connector for CData Sync Views

Name	Description
ImageSearch	Query Google custom search engines for images.
WebSearch	Query the web on Google.

Query Google custom search engines for images.

Table Specific Information

When querying this table the SearchTerms parameter must be specified. For example, to search in ImageSearch for the term 'technology' use the following query:

SELECT * FROM ImageSearch WHERE SearchTerms = 'technology'

To filter out certain queries and include other queries, use a mix of operators on the SearchTerms field:

SELECT * FROM ImageSearch WHERE SearchTerms = 'search1' AND SearchTerms != 'search2' AND SearchTerms > 'x' AND SearchTerms < 'y' OR SearchTerms = 'or this'

To include a site in the search, execute a query like the following:

SELECT * FROM ImageSearch WHERE SearchTerms = 'technology' AND Site = 'https://wikipedia.com/'

Likewise, to exclude a site from the search, execute a query like the following:

SELECT * FROM ImageSearch WHERE SearchTerms = 'technology' AND Site != 'https://wikipedia.com/'

Google search has an aggregate function called TotalResults() that is similar like Count(*).

TotalResults() can be used if you want to get the number of result based on your query.

The Google Search API limits the number of item returned to 100 so count(*) will not be the actual number of search results.

SELECT TotalResults() FROM ImageSearch WHERE SearchTerms = 'ancient artifact' 

Columns

Name	Type	References	Description
SearchTerms	String		The search expression.
Title	String		The title of the search result, in plain text.
HtmlTitle	String		The title of the search result, in HTML.
Link	String		The full URL the search result points to.
DisplayLink	String		An abridged version of the search result URL.
Snippet	String		The snippet of the search result, in plain text.
HtmlSnippet	String		The snippet of the search result, in HTML.
ImageWidth	Integer		The width of the image in pixels.
ImageHeight	Integer		The height of the image in pixels.
Size	Integer		The size of the image in bytes.
ImageThumbnail	String		The link to the thumbnail.
ImageContext	String		The URL of the web page hosting the image.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
TraditionalChineseSearch	Boolean		Enable or disable searches in both Simplified and Traditional Chinese Search.
CountryRestrictions	String		Restrict search results to documents originating in a particular country. This input accepts ISO 3166 2-digit codes.
Date	Datetime		Filter events created after this date.
FileType	String		Filter the results to match the specified file types.
DuplicateFilter	Boolean		Turn on or off the duplicate content filter.
Geolocation	String		Focus the search to a two-letter country code.
UserInterfaceLanguage	String		Specify the interface language (host language) of your user interface.
ImageColorType	String		Return images of a specific color type: color, gray, or mono. The allowed values are color, gray, mono.
ImageDominantColor	String		Return images of a specific dominant color: black, blue, brown, gray, green, pink, purple, teal, white, or yellow. The allowed values are black, blue, brown, gray, green, pink, purple, teal, white, yellow.
ImageSize	String		Return images of a specific size: huge, icon, large, medium, small, large, xlarge, or xxlarge. The allowed values are huge, icon, large, medium, small, large, xlarge, xxlarge.
ImageType	String		Return images of a specific type: clipart, face, lineart, news, or photo. The allowed values are clipart, face, lineart, news, photo.
LinkSite	String		Specify that all search results should contain a link to a particular URL.
LanguageRestrictions	String		Restrict the search results to certain languages. For example: lang_en. The allowed values are lang_ar, lang_bg, lang_ca, lang_cs, lang_da, lang_de, lang_el, lang_en, lang_es, lang_et, lang_fi, lang_fr, lang_hr, lang_hu, lang_id, lang_is, lang_it, lang_iw, lang_ja, lang_ko, lang_lt, lang_lv, lang_nl, lang_no, lang_pl, lang_pt, lang_ro, lang_ru, lang_sk, lang_sl, lang_sr, lang_sv, lang_tr, lang_zh-cn, lang_zh-tw.
RelatedSite	String		Include results that have a URL to the specified related URL.
Rights	String		Filter results based on the reserved rights: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, or cc_nonderived. The allowed values are cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived.
SearchSafety	String		Search safety level: high, medium, or off. The allowed values are high, medium, off.
Site	String		Restrict all search results to pages from the specified site.

Query the web on Google.

Table Specific Information

When querying this table the SearchTerms parameter must be specified. For example, to search in WebSearch for the term 'technology' use the following query:

SELECT * FROM WebSearch WHERE SearchTerms = 'technology'

To filter out certain queries and include other queries, use a mix of operators on the SearchTerms field:

SELECT * FROM WebSearch WHERE SearchTerms = 'search1' AND SearchTerms != 'search2' AND SearchTerms > 'x' AND SearchTerms < 'y' OR SearchTerms = 'or this'

To include a site in the search, execute a query like the following:

SELECT * FROM WebSearch WHERE SearchTerms = 'technology' AND Site = 'https://news.google.com/'

Likewise, to exclude a site in the search, execute a query like the following:

SELECT * FROM WebSearch WHERE SearchTerms = 'technology' AND Site != 'https://news.google.com/'

Google search has an aggregate function called TotalResults() that is similar like Count(*).

TotalResults() can be used if you want to get the number of result based on your query.

The Google Search API limits the number of item returned to 100 so count(*) will not be the actual number of search results.

SELECT TotalResults() FROM WebSearch WHERE SearchTerms = 'ancient artifact' 

Columns

Name	Type	References	Description
SearchTerms	String		The search expression.
Title	String		The title of the search result, in plain text.
HtmlTitle	String		The title of the search result, in HTML.
Link	String		The full URL the search result points to.
DisplayLink	String		An abridged version of the search result URL.
Snippet	String		The snippet of the search result, in plain text.
HtmlSnippet	String		The snippet of the search result, in HTML.
FormattedUrl	String		The formatted URL of the search result.
HtmlFormattedUrl	String		The HTML-formatted URL of the search result.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
TraditionalChineseSearch	Boolean		Enable or disable searches in both Simplified and Traditional Chinese Search.
CountryRestrictions	String		Restrict search results to documents originating in a particular country. This input accepts ISO 3166 2-digit codes.
Date	Datetime		Filter events created after this date.
FileType	String		Filter the results to match the specified file types.
DuplicateFilter	Boolean		Turn on or off the duplicate content filter.
Geolocation	String		Focus the search to a two-letter country code.
UserInterfaceLanguage	String		Specify the interface language (host language) of your user interface.
LinkSite	String		Specifies that all search results should contain a link to a particular URL.
LanguageRestrictions	String		Restrict the search results to certain languages. For example: lang_en. The allowed values are lang_ar, lang_bg, lang_ca, lang_cs, lang_da, lang_de, lang_el, lang_en, lang_es, lang_et, lang_fi, lang_fr, lang_hr, lang_hu, lang_id, lang_is, lang_it, lang_iw, lang_ja, lang_ko, lang_lt, lang_lv, lang_nl, lang_no, lang_pl, lang_pt, lang_ro, lang_ru, lang_sk, lang_sl, lang_sr, lang_sv, lang_tr, lang_zh-cn, lang_zh-tw.
RelatedSite	String		Include results that have a URL to the specified related URL.
Rights	String		Filter results based on the reserved rights: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, or cc_nonderived. The allowed values are cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived.
SearchSafety	String		Search safety level: high, medium, or off. The allowed values are high, medium, off.
Site	String		Restrict all search results to pages from the specified site.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
APIKey	Your key for the Custom Search API.
CustomSearchId	The Id of the Custom Search engine.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your key for the Custom Search API.
CustomSearchId	The Id of the Custom Search engine.

Your key for the Custom Search API.

Remarks

Your key for the Custom Search API. This API must be enabled in the Google API Console. Follow the steps below to obtain an API key. Note that you also need to set the CustomSearchId to connect.

Getting the API Key

To authenticate requests to the Custom Search API, follow the steps below:

1. Log into the Google API console and select a project.
2. In the side bar under APIs & Services, click Library and then select the Custom Search API. Click Enable.
3. In the side bar, click APIs & Services -> Credentials.
4. Click Create Credentials -> API Key.
5. Select the API Key to restrict the key to your platform.

The Id of the Custom Search engine.

Remarks

The Id of the Custom Search engine. You can obtain an Id by logging into your Google account and creating a Custom Search engine. An APIKey is also required to connect.

Creating a Custom Search Engine

Follow the steps below to create a custom search engine and obtain the CustomSearchId value:

1. Sign into the Google Custom Search Engine site.
2. Click New Search Engine and add a site to focus the search on.
3. Click Edit Seach Engine, select your search engine in the menu, and then click Setup.
4. In the Details section, click Search Engine Id to retrieve the search engine Id used as the CustomSearchId in the connection string.
5. In the Sites to Search section, you can additionally select the Search the Entire Web but Emphasize Included Sites option in the menu.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Google Search and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\GoogleSearch Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM WebSearch WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.