Using the driver : Configuring the relational map : Using the Sample property method

Using the Sample property method

The sample property method allows you to access data for a single endpoint with minimal configuration.

To configure the driver to using the Sample property method:

Set the Sample property to specify the endpoint to which you want to connect and sample. For example, https://example.com/countries/.

Optionally, set the Table property to specify the name of the table your endpoint maps to in the relational view of the data. If you do not specify a value, the driver will automatically generate a name based on the composition of the endpoint. For example, the following endpoint:

https://example.com/countries/events/1/

maps to the following table name:

COUNTRIES_EVENTS_1

Optionally, if you want to store the relational map in a resolved REST file, set the CreateMap property to either of the following values:

forceNew: The driver deletes the current REST file, internal configuration files, and relational map in the location specified by the SchemaMap property and creates a new set at the same location.

notExist: The driver uses the current REST file, internal files, and relational map in the location specified by the SchemaMap property. If the files do not exist, the driver creates them.

Note that if no value is specified for CreateMap, the driver defaults to using internal memory to store the map (CreateMap=session).

Optionally, if you are storing the relational map to a REST file (CreateMap=forceNew | notExist) , you can set the SchemaMap property to specify the location to generation the REST and internal driver files. The default location depends on your platform:

For Windows:

<application_data_folder>\Local\Progress\DataDirect\AutoREST_Schema\

For UNIX/Linux:

~/progress/datadirect/AutoREST_Schema/

Optionally, set the values for any required authentication properties. See "Authentication" for details.

For example, the following connection string demonstrates the minimum connection properties to configure the Sample property method:

Connection conn = DriverManager.getConnection
("jdbc:datadirect:autorest:Sample='https://example.com/countries/';");