blob: 701bbc6a90604adc35e8d92594a8d35d49b01718 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="connectors_v2.html">Connectors API</a> . <a href="connectors_v2.projects.html">projects</a> . <a href="connectors_v2.projects.locations.html">locations</a> . <a href="connectors_v2.projects.locations.connections.html">connections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="connectors_v2.projects.locations.connections.actions.html">actions()</a></code>
</p>
<p class="firstline">Returns the actions Resource.</p>
<p class="toc_element">
<code><a href="connectors_v2.projects.locations.connections.entityTypes.html">entityTypes()</a></code>
</p>
<p class="firstline">Returns the entityTypes Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#executeSqlQuery">executeSqlQuery(connection, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="executeSqlQuery">executeSqlQuery(connection, body=None, x__xgafv=None)</code>
<pre>Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be &#x27;select * from Account a, Order o where a.Id = o.AccountId&#x27;.
Args:
connection: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required)
body: object, The request body.
The object takes the form of:
{ # An execute sql query request containing the query and the connection to execute it on.
&quot;query&quot;: { # A wrapper around the SQL query statement. This is needed so that the JSON representation of ExecuteSqlQueryRequest has the following format: `{&quot;query&quot;:&quot;select *&quot;}`. # Required. SQL statement passed by clients like Integration Platform, the query is passed as-is to the driver used for interfacing with external systems.
&quot;query&quot;: &quot;A String&quot;, # Required. Sql query to execute.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response returned by the connection after executing the sql query.
&quot;results&quot;: [ # In the case of successful execution of the query the response contains results returned by the external system. For example, the result rows of the query are contained in the &#x27;results&#x27; Struct list - &quot;results&quot;: [ { &quot;field1&quot;: &quot;val1&quot;, &quot;field2&quot;: &quot;val2&quot;,.. },.. ] Each Struct row can contain fields any type of like nested Structs or lists.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
],
}</pre>
</div>
</body></html>