YouTube Data Model

Connection String Options

  1. Auto Cache
  2. Cache Connection
  3. Cache Driver
  4. Cache Location
  5. Cache Metadata
  6. Cache Query Result
  7. Callback URL
  8. Connect On Open
  9. Content Owner Id
  10. Firewall Password
  11. Firewall Port
  12. Firewall Server
  13. Firewall Type
  14. Firewall User
  15. Initiate OAuth
  16. Location
  17. Logfile
  18. Max Log File Size
  19. OAuth Access Token
  20. OAuth Client Id
  21. OAuth Client Secret
  22. OAuth JWT Cert
  23. OAuth JWT Cert Password
  24. OAuth JWT Cert Subject
  25. OAuth JWT Cert Type
  26. OAuth JWT Issuer
  27. OAuth JWT Subject
  28. OAuth Refresh Token
  29. OAuth Settings Location
  30. Offline
  31. Other
  32. Proxy Auth Scheme
  33. Proxy Auto Detect
  34. Proxy Password
  35. Proxy Port
  36. Proxy Server
  37. Proxy SSL Type
  38. Proxy User
  39. Pseudo Columns
  40. Query Cache
  41. RTK
  42. SSL Server Cert
  43. Support Enhanced SQL
  44. Tables
  45. Timeout
  46. Verbosity
  47. Views

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver maintains a cache in the background. The driver can update the cache when you execute a SELECT query to the remote YouTube data.

This functionality gives you the option to query a persistent, up-to-date cache or execute real-time queries with a failover solution for connectivity loss.

Caching on Every SELECT

 

CacheQueryResult is a way to query YouTube in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and persists the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Videos#CACHE]

 

 

Setting the Caching Database

 

When AutoCache is set, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

 

 

See Also

 

 

  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.
  • QueryCache: In addition to backup, you can also use a local copy of data as a shortcut that minimizes network transit.

    When this property is set, the driver builds a temporary, in-memory dataset that caches the results of the queries you execute. Result sets for subsequent queries are extracted from this dataset, if possible.

    This property is useful in BI, analytics, and other tools that generate queries for you. In these tools, explicit cache queries with the #CACHE syntax may not be an option.

  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the YouTube metadata. Metadata then needs to be retrieved only once instead of every connection.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Cache Connection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. You will need at least the following information to connect to one of the caching databases below. To load the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. The documentation for the underlying JDBC driver will have all of the available properties.

 

Derby and Java DB

 

In most caching scenarios, you need to set only the following:

 

For other Java DB configurations, you will need to use CacheDriver and CacheConnection. Below is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

 

 

SQLite

 

To cache to SQLite, you can use the SQLite JDBC driver. Below is the syntax of the JDBC URL:

jdbc:sqlite:dataSource
  • Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

 

 

MySQL

 

The installation includes the CData JDBC Driver for MySQL. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below are typical connection properties:

 

 

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The username provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.
SQL Server

 

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
Below are typical SQL Server connection properties:
  • Port: The port SQL Server is running on.
  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use Windows authentication. Set this option to false to use forms-based authentication.

    To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.

  • User: The username provided for authentication with SQL Server, if you are using forms authentication.
  • Password: The password provided for authentication with SQL Server, if you are using forms authentication.
Oracle

 

Below is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
Below are typical connection properties:
  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • Password: The password provided for authentication with the Oracle database.
  • User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL

 

Below is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
Below are typical connection properties:
  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • Username: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
  • Password: The password provided for authentication with the PostgreSQL database.

 

 

Cache Driver

Data Type

string

Default Value

""

Remarks

You can cache to any database that you have a JDBC driver for, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.

Note that you must also add the CacheDriver JAR to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

 

 

The driver simplifies Java DB configuration. Java DB is the Oracle distribution of Derby. The JAR is shipped in the JDK. You can find the JAR, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath.

jdbc:youtube:CacheLocation='c:/Temp/cachedir';OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333;
To customize the Java DB JDBC URL, use CacheProvider and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:youtube:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333;
SQLite

 

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:youtube:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333;
MySQL

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

jdbc:youtube:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333;
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for YouTube 2016 installation directory.
SQL Server

 

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:youtube:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333;
Oracle

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:youtube:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333;
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:youtube:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333;

 

 

Cache Location

Data Type

string

Default Value

""

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • QueryCache: Set this to use a temporary, in-memory cache.
  • CacheMetadata: Set this to persist the YouTube catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, the relevant system tables in the YouTube catalog are cached to the file store specified by CacheLocation.

Setting CacheMetadata and CacheLocation will retrieve metadata only once over multiple connections. For example, metadata will be retrieved only when a connection pool is initialized.

When to Use CacheMetadata

 

The driver automatically caches metadata in memory when you open a connection, so within the same connection schema discovery is only expensive on the first query. QueryCache only becomes useful when retrieving the system catalog on every connection open becomes expensive. For example, when you are working with large amounts of metadata or when you have many simultaneous, short-lived connections.

When Not to Use CacheMetadata

 

 

  • When you are working with volatile metadata: To pick up new, changed, or deleted columns, you need to delete and rebuild the metadata cache. In this case, if the default in-memory cache is insufficient, consider a caching solution that will allow you to maintain the cache with CACHE Statements statements. See Caching Data for more information on selecting a caching solution.
  • When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache is set, the entire result of every SELECT query is cached in the cache database. Note that the performance can be significantly impacted when using AutoCache when the YouTube API does not support the REPLICATE Statements statement.

 

Callback URL

Data Type

string

Default Value

""

Remarks

This value is the URL that YouTube redirects to during the authentication process.

 

Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to YouTube when the connection is opened. This property enables the 'Test Connection' feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to YouTube and nothing from this initial connection is maintained.

Setting this property to 'false' may provide performance improvements (depending upon the number of times a connection is opened).

 

Content Owner Id

Data Type

string

Default Value

""

Remarks

The Id of the copyright holder for content in YouTube's rights management system. The content owner is the person or organization that claims videos and sets their monetization policy.

 

Firewall Password

Data Type

string

Default Value

""

Remarks

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

 

Firewall Port

Data Type

string

Default Value

""

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.

 

Firewall Server

Data Type

string

Default Value

""

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 driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

 

Firewall Type

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default the driver 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 driver opens a connection to YouTube and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver 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 driver 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.

 

 

Firewall User

Data Type

string

Default Value

""

Remarks

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

 

Initiate OAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

 

 

Location

Data Type

string

Default Value

""

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files used in your application must be deployed with other assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

""

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. There is no limit by default. Values lower than 100kB will use 100kB as the value instead.

 

OAuth Access Token

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Client Id

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration, you will receive a client Id, sometimes also called a consumer key, and a client secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth Client Secret

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration you will receive a client Id and a client secret, sometimes also called a consumer secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth JWT Cert

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

 

 

   
MY A certificate store holding personal certificates with their associated private keys.
CA Certifying authority certificates.
ROOT Root certificates.
SPC Software publisher certificates.

 

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

 

OAuth JWT Cert Password

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

 

OAuth JWT Cert Subject

Data Type

string

Default Value

"*"

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@cdata.com". Common fields and their meanings are displayed below.

 

   
Field Meaning
CN Common Name. This is commonly a host name like www.server.com.
O Organization
OU Organizational Unit
L Locality
S State
C Country
E Email Address

 

If a field value contains a comma it must be quoted.

 

OAuth JWT Cert Type

Data Type

string

Default Value

""

Remarks

This property can take one of the following values:

 

   
USER - default For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB The certificate store is a string that contains a certificate in XML format.

 

 

OAuth JWT Issuer

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. This is typically either the Client ID or Email Address of the OAuth Application.

 

OAuth JWT Subject

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

 

OAuth Refresh Token

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

 

OAuth Settings Location

Data Type

string

Default Value

"%APPDATA%\\CData\\YouTube Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

This property is useful for connecting to multiple YouTube accounts at once: Set OAuthSettingsLocation to a file unique to the connection.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to TRUE, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

 

Other

Data Type

string

Default Value

""

Remarks

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

Caching Configuration

 

   
CachePartial=True Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True Passes the specified query to the cache database instead of using the SQL parser of the driver.

 

Integration and Formatting

 

   
SupportAccessLinkedMode In Access' linked mode, it is generally a good idea to always use a cache as most data sources do not support multiple Id queries. However if you want to use the driver in Access but not in linked mode, this property must be set to False to avoid using a cache of a SELECT * query for the given table.
ConvertDateTimeToGMT 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.
ClientCulture This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
Culture This setting can be used to specify culture settings that determine how the driver interprets certain data types that are passed into the driver. For example, setting Culture='de-DE' will output German formats even on an American machine.

 

 

Proxy Auth Scheme

Data Type

string

Default Value

"BASIC"

Remarks

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

Note that the driver 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 driver performs HTTP BASIC authentication.
  • DIGEST: The driver performs HTTP DIGEST authentication.
  • NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The driver 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.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Password

Data Type

string

Default Value

""

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 driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

 

Proxy Port

Data Type

string

Default Value

"80"

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.

 

Proxy Server

Data Type

string

Default Value

""

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver 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 driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

 

Proxy SSL Type

Data Type

string

Default Value

"AUTO"

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 driver 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.

 

 

Proxy User

Data Type

string

Default Value

""

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 username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

Data Type

string

Default Value

""

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; i.e., "*=*".

 

Query Cache

Data Type

string

Default Value

""

Remarks

The QueryCache property allows you to cache the results of a query in memory and use them until the cache expires. The cache expires after the seconds specified in this property. The in-memory query cache is shared across connections, so it can help with performance even if more than one connection is being used.

How QueryCache Works

 

The cache manager for QueryCache will not only use the cache for exactly the same query, but also use the cache for queries that represent a subset of data in the cached query. For example, in the following queries, the cache created while executing Query A will be used to obtain the results for both Query B and Query C.

SELECT * FROM Account; // Query A
SELECT * FROM Account WHERE Name LIKE '%John'; // Query B
SELECT Id, Name FROM Account LIMIT 10; // Query C

 

 

When to Use QueryCache

 

Setting the QueryCache property can improve performance in the following scenarios:

  • When you need to execute the same or similar queries from multiple connections: With this property set, all connections share the same temporary cache instead of each executing a query to YouTube. This can be useful in connection pooling.

  •  

    When you need to query cached data with generated queries: Data access wizards and dashboard designers generate an underlying SQL query, which you may have a limited ability to modify. Typically, to pass through SQL to query a cache, you need to set Offline. Offline queries may be unacceptable if your BI and analytics need to reflect changes to the data in real time. But, slow networks or servers can result in reports with unacceptable lag.

    QueryCache enables you to execute standard SQL against a local cache while remaining online to periodically refresh the cache.

    Note that Offline and QueryCache do not provide an ad-hoc way to select a cached table or a remote table after opening a connection; the properties allow access to only one or the other. The #CACHE SQL syntax enables you to explicitly select a cached table, without going offline. Refer to Caching Explicitly for more information.

When Not to Use QueryCache

 

 

  • When you need the most efficient queries possible: By default, the driver offloads as much processing as possible to the server. This results in the least amount of data crossing the network. ; even if a query is not supported and needs some in-memory processing, the driver still leverages the API's capabilities. QueryCache is only desirable when the default functionality is not possible or when there are overriding constraints; for example, even API-optimized queries can be expensive against a slow server.

 

 

RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

SSL Server Cert

Data Type

string

Default Value

""

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 will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

Use QueryCache to cache memory for a given time in seconds or to disable in-memory caching.

Use QueryCache to cache in memory for a given time in seconds or to disable in-memory caching.

 

Tables

Data Type

string

Default Value

""

Remarks

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

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

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

 

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the HTTP requests.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

Views

Data Type

string

Default Value

""

Remarks

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




 

Views

  1. Activities
  2. Captions
  3. Channels
  4. ChannelSections
  5. Comments
  6. CommentThreads
  7. GuideCategories
  8. Languages
  9. PlayListItems
  10. PlayLists
  11. Regions
  12. Subscriptions
  13. VideoAbuseReportReasons
  14. VideoCategories
  15. Videos

Activities

Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube.

 

Table Specific Information

 

 

Select

 

YouTube allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Home. Additionally, extra optional columns supported are PublishedAt and Region.

All columns support the '=' operator. PublishedAt also supports '>', '>=', '<', and '<='.

By default, if no filters are specified, the driver will return activities generated by authenticated user.

SELECT * FROM Activities WHERE Home = true LIMIT 2

SELECT * FROM Activities WHERE ChannelId = "abc123" AND PublishedAt < '2016-01-01T10:00:00Z'
Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String   The Id that YouTube uses to uniquely identify the activity.
PublishedAt Datetime optional The date and time that the activity occurred. The value is in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId String single The Id that YouTube uses to uniquely identify the channel associated with the activity.
Title String   The title of the resource primarily associated with the activity.
Description String   The description of the resource primarily associated with the activity.
ChannelTitle String   Channel title for the channel responsible for this activity.
Type String   The type of activity that the resource describes. Valid values: bulletin, channelItem, comment (not currently returned), favorite, like, playlistItem, recommendation, social, subscription, and upload.
GroupId String   The group Id associated with the activity.
ThumbnailsDefaultUrl String   The URL of the default image thumbnail.
UploadVideoId String   The Id that YouTube uses to uniquely identify the uploaded video.
LikeResourceIdKind String   The type of the resource that received a positive (like) rating.
LikeResourceIdVideoId String   The Id that YouTube uses to uniquely identify the video, if the rated resource is a video. This column is only present if the ResourceIdKind is youtube#video.
FavoriteResourceIdKind String   The type of the YouTube entity marked as a favorite.
FavoriteResourceIdVideoId String   The Id that YouTube uses to uniquely identify the favorite video.
CommentResourceIdKind String   The comment on the API resource.
CommentResourceIdVideoId String   The Id that YouTube uses to uniquely identify the video associated with a comment.
CommentResourceIdChannelId String   The Id that YouTube uses to uniquely identify the channel associated with a comment.
SubscriptionResourceIdKind String   The type of the subscription. A subscription is a channel that a user subscribed to.
SubscriptionResourceIdChannelId String   The Id that YouTube uses to uniquely identify the channel that the user subscribed to.
PlaylistItemResourceIdKind String   The type of the playlist item.
PlaylistItemResourceIdVideoId String   The Id that YouTube uses to uniquely identify the video that was added to the playlist.
PlaylistItemPlaylistId String   The value that YouTube uses to uniquely identify the playlist.
PlaylistItemPlaylistItemId String   The value that YouTube uses to uniquely identify the item in the playlist.
RecommendationResourceIdKind String   The type of the recommendation.
RecommendationResourceIdVideoId String   The Id that YouTube uses to uniquely identify the video, if the recommended resource is a video.
RecommendationResourceIdChannelId String   The Id that YouTube uses to uniquely identify the channel, if the recommended resource is a channel.
RecommendationReason String   The reason that the YouTube entity was recommended to the user. Valid values for this column : unspecified, videoFavorited, videoLiked, and videoWatched.
RecommendationSeedResourceIdKind String   The type of the YouTube entity that caused the recommendation.
RecommendationSeedResourceIdVideoId String   The Id that YouTube uses to uniquely identify the video, if the recommendation was caused by a particular video.
RecommendationSeedResourceIdChannelId String   The Id that YouTube uses to uniquely identify the channel, if the recommendation was caused by a particular channel.
RecommendationSeedResourceIdPlaylistId String   The Id that YouTube uses to uniquely identify the playlist, if the recommendation was caused by a particular playlist.
BulletinResourceIdKind String   The type of channel bulletin post.
BulletinResourceIdVideoId String   The Id that YouTube uses to uniquely identify the video featured in a bulletin post, if the post refers to a video.
BulletinResourceIdChannelId String   The Id that YouTube uses to uniquely identify the channel featured in a bulletin post, if the post refers to a channel.
BulletinResourceIdPlaylistId String   The Id that YouTube uses to uniquely identify the playlist featured in a bulletin post, if the post refers to a playlist.
SocialType String   The name of the social network post. Valid values for this column: facebook, googlePlus, twitter, and unspecified.
SocialResourceIdKind String   The type of the social network post.
SocialResourceIdVideoId String   The Id that YouTube uses to uniquely identify the video featured in a social network post, if the post refers to a video.
SocialResourceIdChannelId String   The Id that YouTube uses to uniquely identify the channel featured in a social network post, if the post refers to a channel.
SocialResourceIdPlaylistId String   The Id that YouTube uses to uniquely identify the playlist featured in a social network post.
SocialAuthor String   The author of the social network post.
SocialReferenceUrl String   The URL of the social network post.
SocialImageUrl String   An image of the author of the post.
ChannelItemResourceId String   The Id of the YouTube entity that was added to the channel.

 

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
Region String Instructs the API to filter by region. The parameter value is an ISO 3166-1 alpha-2 country code.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Captions

Query YouTube Captions. A Caption resource represents a YouTube caption track.

 

Table Specific Information

 

 

Select

 

YouTube allows only a subset of columns to be used as filter criteria. The VideoId column must be specified. Extra optional columns supported are Id and OnBehalfOfContentOwner.

All columns support the '=' operator.

SELECT * FROM Captions WHERE VideoId = '123456789'
Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String optional The Id that YouTube uses to uniquely identify the caption track.
VideoId String single The Id that YouTube uses to uniquely identify the video associated with the caption track.
LastUpdated Datetime   The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
TrackKind String   The type of the caption track. Valid values for this column: ASR (a caption track generated using automatic speech recognition); Forced (a caption track that plays when no other track is selected in the player. For example, a video that shows aliens speaking in an alien language might have a forced caption track to only show subtitles for the alien language); standard (a regular caption track. This is the default value).
Language String   The language of the caption track. The column value is a BCP-47 language tag.
Name String   The name of the caption track. The name is intended to be visible to the user as an option during playback.
AudioTrackType String   The type of audio track associated with the caption track. Valid values for this column: commentary (the caption track corresponds to an alternate audio track that includes commentary, such as director commentary); descriptive (the caption track corresponds to an alternate audio track that includes additional descriptive audio); primary (the caption track corresponds to the primary audio track for the video, which is the audio track normally associated with the video); unknown (this is the default value).
IsCC Boolean   Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
IsLarge Boolean   Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
IsEasyReader Boolean   Indicates whether the caption track is formatted for easy reader, meaning it is at a third-grade level for language learners. The default value is false.
IsDraft Boolean   Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
IsAutoSynced Boolean   Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
Status String   The status of the caption track. Valid values for this column: failed, serving, syncing.
FailureReason String   The reason that YouTube failed to process the caption track. Valid values: processingFailed (YouTube failed to process the uploaded caption track); unknownFormat (the format of the caption track was not recognized); unsupportedFormat (the format of the caption track is not supported).

 

 

 

Channels

Query YouTube Channels.

 

Table Specific Information

 

 

Select

 

By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

By default, if no filters are specified, the driver will return all channels owned by the authenticated user.

YouTube allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: CategoryId or Id. Extra optional columns supported are Language and ChannelId.

A search against all channels in YouTube may be triggered by specifying one or more of SearchTerms, ChannelId, Region, SafeSearch, Rating, or Relevance to search all channels.

All columns support the '=' operator. 'PublishedAt', also supports '>', '>=', '<', and '<='.

Order by is supported for the Rating, Relevance, and Title columns.

SELECT * FROM Channels WHERE Id = 'abc123'

SELECT * FROM Channels WHERE ChannelId = 'abc123' AND SearchTerms = 'music|movies-horror' ORDER BY Rating LIMIT 10

 

Note: Ordering is not supported when specifying one of the colums used for searching channels such as SearchTerms.

Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the channel.
Title String unsupported The title of the channel.
Description String unsupported The description of the channel. The value of the column has a maximum length of 1000 characters.
PublishedAt Datetime searchspecific The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ThumbnailsDefaultUrl String unsupported The URL of the default image thumbnail.
DefaultLanguage String unsupported This column is confidential to trusted testers.
LiveBroadcastContent String unsupported An indication of whether a video or channel resource has live broadcast content.
LocalizedTitle String unsupported This column is confidential to trusted testers. The localized video title.
LocalizedDescription String unsupported This column is confidential to trusted testers. The localized video description.
Country String unsupported The country with which the channel is associated.
ViewCount Long unsupported The number of times the channel has been viewed.
CommentCount Long unsupported The number of comments for the channel.
SubscriberCount Long unsupported The number of subscribers that the channel has.
HiddenSubscriberCount Boolean unsupported Indicates whether the subscriber count of the channel is publicly visible.
VideoCount Long unsupported The number of videos uploaded to the channel.
RelatedPlaylistsLikes String unsupported The Id of the playlist that contains the liked videos of the channel.
RelatedPlaylistsFavorites String unsupported The Id of the playlist that contains the favorite videos of the channel.
RelatedPlaylistsUploads String unsupported The Id of the playlist that contains the uploaded videos of the channel.
GooglePlusUserId String unsupported The GooglePlusUserId object identifies the Google+ profile Id associated with this channel.
PrivacyStatus String unsupported Privacy status of the channel. Valid values for this column: private, public, unlisted.
IsLinked Boolean unsupported Indicates whether the channel data identifies a user who is already linked to either a YouTube username or a Google+ account. A user who has one of these links already has a public YouTube identity, which is a prerequisite for several actions, such as uploading videos.
LongUploadsStatus String unsupported Indicates whether the channel is eligible to upload videos that are more than 15 minutes long. This column is only returned if the channel owner authorized the API request. See the YouTube Help Center for more information about this feature.
Keywords String unsupported Keywords associated with your channel. The value is a space-separated list of strings.
DefaultTab String unsupported The content tab that users should display by default when viewers arrive at your channel page.
TrackingAnalyticsAccountId String unsupported The Id for a Google Analytics account that you want to use to track and measure traffic to your channel.
ModerateComments Boolean unsupported This setting determines whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. The default value is false.
ShowRelatedChannels Boolean unsupported This setting indicates whether YouTube should show an algorithmically generated list of related channels on your channel page.
ShowBrowseView Boolean unsupported This setting indicates whether the channel page should display content in a browse or feed view. For example, the browse view might display separate sections for uploaded videos, playlists, and liked videos. The feed view, on the other hand, displays the activity feed of the channel.
FeaturedChannelsTitle String unsupported The title that displays above the featured channels module. The title has a maximum length of 30 characters.
SearchTerms String searchspecific The SearchTerms parameter specifies the query term to search for.

 

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
CategoryId String The Id of the associated YouTube guide category.
ForUsername String The username associated with the channel.
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ChannelId String The Id that YouTube uses to uniquely identify a channel.
Region String The country associated with the channel.
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
Rating String Resources are sorted from highest to lowest rating.
Relevance String Resources are sorted based on their relevance to the search query. This is the default value for this parameter.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

ChannelSections

Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature.

 

Table Specific Information

 

 

Select

 

YouTube allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Id. Extra optional columns supported are Language and OnBehalfOfContentOwner.

All columns support the '=' operator.

By default, if no channel id is specified, the driver will return channel sections for the channel owned by authenticated user.

SELECT * FROM ChannelSections WHERE ChannelId = '123456789'
Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the channel section.
Type String   The type of the channel section.
Style String   The format in which the channel section displays.
ChannelId String single The Id that YouTube uses to uniquely identify the channel.
Title String   The title of the section.
Position Integer   The position of the section on the channel page.
DefaultLanguage String   The language of the text in the Title column.
LocalizedTitle String   The localized channel section title.
PlaylistsAggregate String   A list of one or more playlist Ids that are featured in a channel section. You must specify a list of playlist Ids if the type of the ChannelSection is either singlePlaylist or multiplePlaylists, and this column should not be specified for other types of sections. If the type is singlePlaylist, this list must specify exactly one playlist Id.
ChannelsAggregate String   A list of one or more channel Ids that are featured in a channel section. You must specify a list of channel Ids if the Type of the ChannelSection is multipleChannels, and this column should not be specified for other types of sections. You cannot include your own channel in the list.

 

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
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.

 

 

 

Comments

Query YouTube Comments.

 

Table Specific Information

 

 

Select

 

YouTube allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: Id or ParentId. Extra optional columns supported are TextFormat.

All columns support the '=' operator.

SELECT * FROM Comments WHERE Id = '123456789'
Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the comment.
ChannelId String   The Id of the YouTube channel associated with the comment. If the comment is a video comment, then this column identifies the channel of the video, and the VideoId column identifies the video. If the comment is a channel comment, then this column identifies the channel that the comment is about.
VideoId String   The Id of the video that the comment refers to.
TextDisplay String   The text of the comment. The text can be retrieved in either plaintext or HTML. The TextFormat pseudo column specifies the desired text format.
TextOriginal String   The original, raw text of the comment as it was initially posted or last updated. The original text is only returned if it is accessible to the authenticated user, which is only guaranteed if the user is the author of the comment.
ParentId String single The unique Id of the parent comment. This column value is only set if the comment was submitted as a reply to another comment.
AuthorDisplayName String   The display name of the user who posted the comment.
AuthorProfileImageUrl String   The URL for the avatar of the user who posted the comment.
AuthorChannelUrl String   The URL of the YouTube channel of the comment author, if available.
AuthorChannelIdValue String   The Id of the YouTube channel of the comment author, if available.
AuthorGoogleplusProfileUrl String   The URL of the Google+ profile of the comment author, if available.
CanRate Boolean   This setting indicates whether the current viewer can rate the comment.
ViewerRating String   The rating the viewer has given to this comment. Valid values for this column: like, none. Note that this column does not currently identify dislike ratings. The column value is like if the viewer has rated the comment positively. The value is none in all other cases, including the user having given the comment a negative rating or not having rated the comment.
LikeCount Integer   The total number of likes (positive ratings) the comment has received.
ModerationStatus String   The moderation status of the comment. This value is only returned if the API request was authorized by the owner of the channel or the video on which the requested comments were made. In addition, note that this value is not set if the query filtered on the Id column. Valid values: heldForReview, likelySpam, published, rejected.
PublishedAt Datetime   The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
UpdatedAt Datetime   The date and time when the comment was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

 

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
TextFormat String This parameter indicates whether the API should return comments formatted as HTML or as plaintext.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

CommentThreads

Query YouTube CommentThreads. A CommentThread record contains information about a YouTube comment thread, a top-level comment and replies, if any exist, to that comment.

 

Table Specific Information

 

 

Select

 

YouTube allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: AllThreadsRelatedToChannelId, ChannelId, Id, or VideoId.

Extra optional columns supported are ModerationStatus, SearchTerms, and TextFormat. All columns support the '=' operator.

Order is supported for CommentThreads. Relevance are the supported order columns.

SELECT * FROM CommentThreads WHERE VideoId = 'abcdef123456' ORDER BY Relevance DESC LIMIT 10

 

Note: Ordering is not supported for use in conjunction with the Id parameter.

Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the comment thread.
ChannelId String single The YouTube channel that is associated with the comments in the thread. The VideoId column identifies the video. If the comments are about a video, then the value identifies the channel that uploaded the video. If the comments refer to the channel itself, the VideoId column will not have a value.
VideoId String single The Id of the video that the comments refer to, if any. If this column is not present or does not have a value, then the thread applies to the channel and not to a specific video.
TopCommentId String   The Id of the top-level comment of the thread.
PublishedAt Datetime   The publish date of the top-level comment of the thread.
UpdatedAt Datetime   The last update date of the top-level comment of the thread.
TopCommentChannelId String   The Id of the channel associated with the top-level comment of the thread.
TopCommentVideoId String   The Id of the video associated with the top-level comment of the thread.
TopCommentTextDisplay String   The display text of the top-level comment of the thread.
TopCommentTextOriginal String   The original text of the top-level comment of the thread.
TopCommentParentId String   The Id of the parent of the top-level comment of the thread.
TopCommentAuthorDisplayName String   The display name of the author of the top-level comment of the thread.
TopCommentAuthorChannelIdValue String   The Id of the channel of the author of the top-level comment of the thread.
TopCommentCanRate Boolean   Whether the current user can rate the top-level comment of the thread.
TopCommentViewerRating String   The viewer rating of the top-level comment of the thread.
TopCommentLikeCount Integer   The like count of the top-level comment of the thread.
TopCommentModerationStatus String   The moderation status of the top-level comment of the thread.
CanReply Boolean   This setting indicates whether the current viewer can reply to the thread.
TotalReplyCount Integer   The total number of replies that have been submitted in response to the top-level comment.
IsPublic Boolean   This setting indicates whether the thread, including all of its comments and comment replies, is visible to all YouTube users.
CommentsAggregate String   A list of one or more replies to the top-level comment.

 

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
AllThreadsRelatedToChannelId String Instructs the API to return all comment threads associated with the specified channel.
ModerationStatus String Set this parameter to limit the returned comment threads to a particular moderation state.
TextFormat String Set the value of this parameter to HTML or plainText.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

GuideCategories

Query YouTube GuideCategories. A GuideCategory resource identifies a category that YouTube algorithmically assigns based on a content of a channel or other indicators, such as the popularity of the channel.

 

Table Specific Information

 

 

Select

 

YouTube allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: Id or Region. If you do not specify any filtering criteria, by default you will get results for the US Region. An extra optional column is Language.

All columns support the '=' operator.

SELECT * FROM GuideCategories WHERE Region = 'JP'
Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the guide category.
ChannelId String   The Id that YouTube uses to uniquely identify the channel publishing the guide category.
Title String   The title of the category.
Region String single Instructs the API to return the list of guide categories available in the specified country.

 

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
Language String The hl parameter specifies the language that will be used for text values in the API response. The default value is en-US.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Languages

Query YouTube i18nLanguages. An i18nLanguage resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language.

 

Table Specific Information

 

 

Select

 

There are no required filters for this table. An optional column supported is Language.

All columns support the '=' operator.

Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String   The Id that YouTube uses to uniquely identify the i18n language.
Language String   A BCP-47 code that uniquely identifies a language.
Name String   The name of the language as it is written in that language.

 

 

 

PlayListItems

Query YouTube PlayListItems. A PlayListItem resource identifies another YouTube entity, such as a Video, that is included in a PlayList. In addition, the PlayListItem record contains details about how that entity is used in that PlayList.

 

Table Specific Information

 

 

Select

 

You must specify exactly one of the following columns in the WHERE clause: Id or PlayListId. Extra optional columns supported are OnBehalfOfContentOwner and VideoId.

All columns support the '=' operator.

SELECT * FROM PlaylistItems WHERE PlaylistId = 'abcdef123456'
Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the playlist item.
PublishedAt Datetime   The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId String   The Id that YouTube uses to uniquely identify the user that added the item to the playlist.
Title String   The title of the item.
Description String   The description of the item.
ThumbnailsDefaultUrl String   The URL of the item.
ChannelTitle String   The channel title of the channel that the playlist item belongs to.
PlaylistId String single The Id that YouTube uses to uniquely identify the playlist that the playlist item is in.
Position String   The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
ResourceIdKind String   The kind, or type, of the referred resource.
ResourceIdVideoId String   If the ResourceIdKind value of the column is youtube#video, then this column will be present and its value will contain the Id that YouTube uses to uniquely identify the video in the playlist.
VideoId String   The Id that YouTube uses to uniquely identify a video. To retrieve the video resource, set the Id column to this value.
Note String   A user-generated note for this item.
PrivacyStatus String   The privacy status of the playlist item.

 

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
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

PlayLists

Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users.

 

Table Specific Information

 

 

Select

 

By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

By default, if no filters are specified, the CData JDBC Driver for YouTube 2016 will return all playlists for the channel owned by authenticated user.

YouTube allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Id. Extra optional columns supported are PublishedAt, Language, OnBehalfOfContentOwner, and OnBehalfOfContentOwnerChannel.

A search against all channels in YouTube may be triggered by specifying one or more of SearchTerms, ForContentOwner, Region, SafeSearch, Rating and Rating to search all playlists.

All columns support the '=' operator. PublishedAt also supports these additional operators: '>', '>=', '<', and '<='.

Order by is supported for the Rating, Relevance, and Title columns.

SELECT * FROM PlayLists WHERE Id = 'abcdef123456'

SELECT title from PlayLists WHERE PublishedAt >= '2016-01-01' ORDER BY Title LIMIT 10

 

Note: Ordering is not supported when specifying one of the colums used for searching playlists such as SearchTerms.

Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the playlist.
PublishedAt Datetime single The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId String single The Id that YouTube uses to uniquely identify the channel that published the playlist.
Title String   The title of the playlist.
Description String   The description of the playlist.
ThumbnailsDefaultUrl String   The URL of the image.
ChannelTitle String   Channel title of the channel that the video belongs to.
DefaultLanguage String   This column is confidential to trusted testers. The language of the text in the Title and Description columns.
LocalizedTitle String   This column is confidential to trusted testers. The localized playlist title.
LocalizedDescription String   This column is confidential to trusted testers. The localized playlist description.
PrivacyStatus String   The privacy status of the playlist. Valid values for this column: private, public, unlisted.
VideoCount Integer   The number of videos in the playlist.
EmbedHtml String   An iframe tag that embeds a player that will play the playlist.
SearchTerms String searchspecific The SearchTerms parameter specifies the query term to search for.

 

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
Language String A value of hl instructs the API to retrieve localized resource metadata for a specific application language that the YouTube supports.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.
OnBehalfOfContentOwnerChannel String Specifies the YouTube channel Id of the channel to which a video is being added.
ForContentOwner String Restricts the search to only retrieve playlists owned by the content owner specified by the OnBehalfOfContentOwner column.
Region String Instructs the API to return search results for the specified country.
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Valid values: moderate, none, or strict.
Rating String Specifies that playlists are sorted from highest to lowest rating.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Regions

Query YouTube i18nRegions. An i18nRegion resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale.

 

Table Specific Information

 

 

Select

 

There are no required filters for this table. An optional column supported is Language.

All columns support the '=' operator.

Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String   The Id that YouTube uses to uniquely identify the i18n region.
Country String   The two-letter ISO country code that identifies the region.
Name String   The name of the region.

 

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
Language String The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US.

 

 

 

Subscriptions

Query YouTube User Subscriptions. A Subscription notifies a User when new Videos are added to a Channel, or when another user takes one of several actions on YouTube, such as uploading a Video, rating a Video, or commenting on a Video.

 

Table Specific Information

 

 

Select

 

You can specify exactly one of the following columns: ChannelId, Id, MyRecentSubscribers, or MySubscribers.

Extra optional columns supported are ForChannelId, OnBehalfOfContentOwner, and OnBehalfOfContentOwnerChannel. All columns support the '=' operator.

Order is supported for Subscriptions. 'Alphabetical', 'Relevance', and 'Unread' are the supported order columns.

By default, if no filters are specified, the driver will return a list of channels subscribed by authenticated user.

SELECT Title FROM Subscriptions WHERE ChannelId = 'abc123' ORDER BY Unread DESC

 

The default value is SUBSCRIPTION_ORDER_RELEVANCE.

Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the subscription.
PublishedAt Datetime   The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelTitle String   The title of the channel that the subscription belongs to.
Title String   The title of the subscription.
Description String   The details of the subscription.
ResourceIdKind String   The type of the API resource.
ResourceIdChannelId String   The value that YouTube uses to uniquely identify the channel that the user subscribed to.
ChannelId String single The Id that YouTube uses to uniquely identify the channel of the subscriber.
ThumbnailsDefaultUrl String   The URL of the default image.
TotalItemCount Integer   The approximate number of items that the subscription points to.
NewItemCount Integer   The number of new items in the subscription since its content was last read.
ActivityType String   The type of activity this subscription is for. Valid values: all, uploads.
SubscriberTitle String   The title of the channel of the subscriber.
SubscriberDescription String   The description of the channel of the subscriber.
SubscriberChannelId String   The Id that YouTube assigns to uniquely identify the channel of the subscriber.
SubscriberThumbnailsDefaultUrl String   The URL of the default 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
MySubscribers String Set this value of this parameter to true to retrieve a feed of the subscribers of the authenticated user.
ForChannelId String The ForChannelId column specifies a comma-separated list of channel Ids.
OnBehalfOfContentOwner String This column is intended exclusively for YouTube content partners.
OnBehalfOfContentOwnerChannel String Specifies the YouTube ChannelId of the channel to which a video is being added.
Alphabetical String Sort alphabetically
Relevance String Sort by relevance.
Unread String Sort by order of activity.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

VideoAbuseReportReasons

Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content.

 

Table Specific Information

 

 

Select

 

There are no required filters for this table. An optional column is Language.

The '=' operator is supported for this column.

Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String   The Id that YouTube uses to identify the reason.
Label String   The label text for the reason.
SecondaryReasonsAggregate String   A list of secondary reasons associated with the reason, if any available. There might be 0 or more.

 

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
Language String The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US.

 

 

 

VideoCategories

Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos.

 

Table Specific Information

 

 

Select

 

You can specify exactly one of the following columns: Id or Region. If you do not specify any filtering criteria, by default you will get results for the US Region. An extra optional parameter is Language.

SELECT * FROM VideoCategories WHERE Region = 'JP'
The IN operator can be used to filter on multiple Ids:
SELECT Id, Kind, Etag, ChannelId, Title, Assignable
FROM   VideoCategories
WHERE  (ID IN ('1', '2', '10'))
Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The unique identifier for the video category.
ChannelId String single The YouTube channel that created the video category.
Title String   The title of the video category.
Assignable Boolean   Indicates whether videos can be associated with the category.
Region String single The country from which to retrieve video categories.

 

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
Language String Specifies the language that should be used for text values in the API response. The default value is en_US.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Videos

Query YouTube Videos.

 

Table Specific Information
Select

 

By default, SupportEnhancedSQL is set to true, and the following will be passed to YouTube if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

By default, if no filters are specified, the driver will return all videos owned by the authenticated user.

Only one of the following columns may be filtered by at a time: Id, MyRating, ChannelId, or Chart. Extra columns supported are ForMine, Language, ForContentOwner, OnBehalfOfContentOwner.

A search against all videos on Youtube may be executed by specifying SearchTerms, RelatedToVideoId, VideoDuration, VideoCategoryId, or Region.

All columns support the '=' operator. PublishedAt also supports these additional operators: '>', '>=', '<', and '<='. Id and ChannelId supports IN.

Order by is supported for the Date, Rating, Relevance and Title columns.

SELECT * FROM Videos WHERE Id = '12345679'

SELECT * FROM Videos WHERE PublishedAt >= '2016-01-01T20:30:00Z' LIMIT 10

SELECT Description FROM Videos WHERE ForMine = True ORDER BY Date

 

Note: Ordering is not supported when specifying one of the colums used for searching channels such as SearchTerms.

The IN operator can be used to specify a list of channels. This call returns a list of videos for each specified channel.

SELECT * FROM Videos WHERE ChannelId IN (a, b, c)
SELECT * FROM Videos WHERE ChannelId IN (SELECT Id FROM Channels)

 

IN operator can also be used for getting data for miltiple videos.

SELECT * FROM Videos WHERE Id IN (a, b, c)
Columns

 

 

 

   
Name Type FilterType Description
Id [KEY] String single The Id that YouTube uses to uniquely identify the video.
ChannelId String single The Id that YouTube uses to uniquely identify the channel that the video was uploaded to.
CategoryId String unsupported The YouTube video category associated with the video.
Title String unsupported The title of the video.
ChannelTitle String unsupported Channel title for the channel that the video belongs to.
PublishedAt Datetime searchspecific The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Description String unsupported The description of the video.
Duration String unsupported The length of the video. The property value is an ISO 8601 duration.
ViewCount Long unsupported The number of times the video has been viewed.
LikeCount Long unsupported The number of users who have indicated that they liked the video.
DislikeCount Long unsupported The number of users who have indicated that they disliked the video.
CommentCount Long unsupported The number of comments for the video.
EmbedHtml String unsupported An iframe tag that embeds a player that will play the video.
PublicStatsViewable Boolean unsupported This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false.
TagsAggregate String unsupported A list of keyword tags associated with the video.
LiveBroadcastContent String unsupported Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming.
Dimension String unsupported Indicates whether the video is available in 3D or in 2D.
Definition String unsupported Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd.
Caption String unsupported Indicates whether captions are available for the video. Valid values for this column: false, true.
LicensedContent Boolean unsupported Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner.
PrivacyStatus String unsupported The privacy status of the playlist. Valid values: private, public, unlisted.
License String unsupported The license. Valid values: creativeCommon, youtube.
Embeddable Boolean unsupported This value indicates whether the video can be embedded on another website.
ThumbnailsDefaultUrl String unsupported The URL of the default image.
DefaultLanguage String unsupported This column is confidential to trusted testers. The language of the text in the Title and Description columns.
DefaultAudioLanguage String unsupported The default_audio_language column specifies the language spoken in the default audio track of the video.
UploadStatus String unsupported The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded.
FailureReason String unsupported This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted.
RejectionReason String unsupported This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended.
LocationDescription String unsupported The text description of the location where the video was recorded.
RecordingDate Datetime unsupported The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
SearchTerms String searchspecific The query term to search for.

 

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
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
RelatedToVideoId String Retrieves a list of videos that are related to the video that the column value identifies.
VideoDuration String Filters video search results based on their duration. Acceptable values: any, long, medium or short.
VideoCategoryId String The videoCategoryId parameter identifies the video category for which the chart should be retrieved.
Region String Instructs the API to select a video chart available in the specified region. This column can only be used in conjunction with the chart column. The parameter value is an ISO 3166-1 alpha-2 country code.
ForMine String Restricts the search to only retrieve videos owned by the authenticated user. It is false by default.
Chart String This parameter can only be used in a properly authorized request. Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.
MyRating String The rating of the authenticated user. Acceptable values: like or dislike.
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ForContentOwner String Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.
Rows@Next String This is used to page through multiple pages of results and should not be set manually.