Skip to content

updated docs, naive transforms #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffreyaven merged 1 commit into from
Feb 20, 2026
Merged

updated docs, naive transforms #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
32 changes: 29 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ npm run test-meta-routes -- awscc --ignore-no-methods
npm run stop-server
```

npm run test-meta-routes -- awscc --ignore-no-methods

### 6. Testing locally with `stackql`
1. ensure the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables are set
2. download the latest `stackql` binary, for example `curl -L https://bit.ly/stackql-zip -O && unzip stackql-zip` for Linux systems
Expand All @@ -52,7 +50,35 @@ REG_STR='{"url": "file://'${PROVIDER_REGISTRY_ROOT_DIR}/openapi'", "localDocRoot

```sql
select * from awscc.s3.buckets_list_only WHERE region = 'us-east-1';
select bucket_name, region, bucket_encryption from awscc.s3.buckets WHERE region = 'us-east-1' and data__Identifier = 'stackql-trial-bucket-01';

select bucket_name, region, bucket_encryption from awscc.s3.buckets WHERE region = 'us-east-1' and Identifier = 'stackql-trial-bucket-01';

select
ResourceARN as resource_arn,
json_extract(json_each.value, '$.Key') as key,
json_extract(json_each.value, '$.Value') as value
from awscc.tagging.tagged_resources, json_each(tags)
where region = 'us-east-1'
and ResourceTypeFilters = '["s3:bucket"]';

select resource_arn, key, value from
(
select
ResourceARN as resource_arn,
json_extract(json_each.value, '$.Key') as key,
json_extract(json_each.value, '$.Value') as value
from awscc.tagging.tagged_resources, json_each(tags)
where region = 'us-east-1'
and ResourceTypeFilters = '["s3:bucket"]'
and TagFilters = '[{"Key": "StackName", "Values": ["stackql-serverless"]}]'
) t
where key = 'StackName' and value = 'stackql-serverless';

select
*
from awscc.tagging.tagged_resources
where region = 'us-east-1';

```

### 6. Generate web docs:
Expand Down
22 changes: 11 additions & 11 deletions bin/generate-docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ function createDeleteExample(serviceName, resourceName, resourceData, thisSchema
${sqlCodeBlockStart}
/*+ delete */
DELETE FROM ${providerName}.${serviceName}.${resourceName}
WHERE data__Identifier = '<${resourceData['x-identifiers'].join('|')}>'
WHERE Identifier = '<${resourceData['x-identifiers'].join('|')}>'
AND region = 'us-east-1';
${codeBlockEnd}
`;
Expand Down Expand Up @@ -237,11 +237,11 @@ function createUpdateExample(serviceName, resourceName, resourceData, thisSchema
${sqlCodeBlockStart}
/*+ update */
UPDATE ${providerName}.${serviceName}.${resourceName}
SET data__PatchDocument = string('{{ {
SET PatchDocument = string('{{ {
${patchFields}
} | generate_patch_document }}')
WHERE region = '{{ region }}'
AND data__Identifier = '${identifierValues}';
AND Identifier = '${identifierValues}';
${codeBlockEnd}
`;
}
Expand Down Expand Up @@ -445,8 +445,8 @@ function createResourceIndexContent(serviceName, resourceName, resourceType, res

const requiredParamsMap = {
create_resource: (schema['x-required-properties'] ? schema['x-required-properties'].join(', ') + ', region' : 'region'),
delete_resource: "data__Identifier, region",
update_resource: "data__Identifier, data__PatchDocument, region",
delete_resource: "Identifier, region",
update_resource: "Identifier, PatchDocument, region",
};

const sqlExampleSelect = `SELECT`;
Expand Down Expand Up @@ -486,13 +486,13 @@ function createResourceIndexContent(serviceName, resourceName, resourceType, res
if (methodName.includes('list')) {
requiredParams = 'region';
} else if (methodName.includes('get') || methodName.includes('describe')) {
requiredParams = 'data__Identifier, region';
requiredParams = 'Identifier, region';
} else if (methodName.includes('create')) {
requiredParams = 'data__Identifier, region';
requiredParams = 'Identifier, region';
} else if (methodName.includes('update') || methodName.includes('modify')) {
requiredParams = 'data__Identifier, data__PatchDocument, region';
requiredParams = 'Identifier, PatchDocument, region';
} else if (methodName.includes('delete')) {
requiredParams = 'data__Identifier, region';
requiredParams = 'Identifier, region';
}

sqlVerbsList.push({
Expand Down Expand Up @@ -644,12 +644,12 @@ function createResourceIndexContent(serviceName, resourceName, resourceType, res
sqlVerbsList.push({
sqlVerbName: 'select',
methodName: 'get_resource',
requiredParams: 'data__Identifier, region'
requiredParams: 'Identifier, region'
});
}

const identifierValues = resourceIdentifiers.map(id => `<${id}>`).join('|');
const identifierClause = `data__Identifier = '${identifierValues}'`;
const identifierClause = `Identifier = '${identifierValues}'`;

sqlExampleListWhere = `${sqlExampleWhere};`;
globalServices.includes(serviceName) ? sqlExampleGetWhere = `WHERE ${identifierClause};`: sqlExampleGetWhere = `${sqlExampleWhere} AND ${identifierClause};`;
Expand Down
14 changes: 7 additions & 7 deletions lib/utils/stackql-utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ function generateSelectQuery({
if(isPlural && schema['x-stackql-primary-identifier']){
selectQuery += handlePrimaryIdentifierProperty(dbms, schema['x-stackql-primary-identifier'], openApiSpec);
} else {
selectQuery += "data__Identifier,\n";
selectQuery += "Identifier,\n";
for (const propertyName in schema.properties) {
// Use simple property handler for all properties
selectQuery += handleSimpleProperty(dbms, propertyName);
Expand All @@ -160,11 +160,11 @@ function generateSelectQuery({

// Append the FROM clause based on whether it is plural or singular
if (isPlural){
selectQuery += `\nFROM ${providerName}.cloud_control.resources WHERE data__TypeName = '${typeName}'`;
selectQuery += `\nFROM ${providerName}.cloud_control.resources WHERE TypeName = '${typeName}'`;
} else {
const primaryIdentifiers = schema['x-stackql-primary-identifier'];
const identifierValues = primaryIdentifiers.map(id => `<${id}>`).join('|');
selectQuery += `\nFROM ${providerName}.cloud_control.resource WHERE data__TypeName = '${typeName}'\nAND data__Identifier = '${identifierValues}'`;
selectQuery += `\nFROM ${providerName}.cloud_control.resource WHERE TypeName = '${typeName}'\nAND Identifier = '${identifierValues}'`;
}

return selectQuery;
Expand Down Expand Up @@ -469,10 +469,10 @@ export function generateStackqlViews(openApiSpec) {
config: {
views: {
select: {
predicate: 'sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ]',
predicate: 'sqlDialect == "sqlite3" && requiredParams == [ Identifier ]',
ddl: `${sqlliteSelectQuerySingular}${regionClause}`,
fallback: {
predicate: 'sqlDialect == "postgres" && requiredParams == [ data__Identifier ]',
predicate: 'sqlDialect == "postgres" && requiredParams == [ Identifier ]',
ddl: `${postgresSelectQuerySingular}${regionClause}`,
},
},
Expand Down Expand Up @@ -510,13 +510,13 @@ export function generateStackqlViews(openApiSpec) {
// config: {
// views: {
// select: {
// predicate: 'sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ]',
// predicate: 'sqlDialect == "sqlite3" && requiredParams == [ Identifier ]',
// ddl: `${sqlliteSelectQuerySingular}${regionClause}`,
// fallback: {
// predicate: 'sqlDialect == "sqlite3"',
// ddl: `${sqlliteSelectQueryListofGets}`,
// fallback: {
// predicate: 'sqlDialect == "postgres" && requiredParams == [ data__Identifier ]',
// predicate: 'sqlDialect == "postgres" && requiredParams == [ Identifier ]',
// ddl: `${postgresSelectQuerySingular}${regionClause}`,
// fallback: {
// predicate: 'sqlDialect == "postgres"',
Expand Down
20 changes: 10 additions & 10 deletions openapi/src/awscc/v00.00.00000/services/accessanalyzer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,34 +742,34 @@ components:
config:
views:
select:
predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ]
predicate: sqlDialect == "sqlite3" && requiredParams == [ Identifier ]
ddl: |-
SELECT
region,
data__Identifier,
Identifier,
JSON_EXTRACT(Properties, '$.AnalyzerName') as analyzer_name,
JSON_EXTRACT(Properties, '$.ArchiveRules') as archive_rules,
JSON_EXTRACT(Properties, '$.Arn') as arn,
JSON_EXTRACT(Properties, '$.Tags') as tags,
JSON_EXTRACT(Properties, '$.Type') as type,
JSON_EXTRACT(Properties, '$.AnalyzerConfiguration') as analyzer_configuration
FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer'
AND data__Identifier = '<Arn>'
FROM awscc.cloud_control.resource WHERE TypeName = 'AWS::AccessAnalyzer::Analyzer'
AND Identifier = '<Arn>'
AND region = 'us-east-1'
fallback:
predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ]
predicate: sqlDialect == "postgres" && requiredParams == [ Identifier ]
ddl: |-
SELECT
region,
data__Identifier,
Identifier,
json_extract_path_text(Properties, 'AnalyzerName') as analyzer_name,
json_extract_path_text(Properties, 'ArchiveRules') as archive_rules,
json_extract_path_text(Properties, 'Arn') as arn,
json_extract_path_text(Properties, 'Tags') as tags,
json_extract_path_text(Properties, 'Type') as type,
json_extract_path_text(Properties, 'AnalyzerConfiguration') as analyzer_configuration
FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer'
AND data__Identifier = '<Arn>'
FROM awscc.cloud_control.resource WHERE TypeName = 'AWS::AccessAnalyzer::Analyzer'
AND Identifier = '<Arn>'
AND region = 'us-east-1'
analyzers_list_only:
name: analyzers_list_only
Expand All @@ -792,15 +792,15 @@ components:
SELECT
region,
JSON_EXTRACT(Properties, '$.Arn') as arn
FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer'
FROM awscc.cloud_control.resources WHERE TypeName = 'AWS::AccessAnalyzer::Analyzer'
AND region = 'us-east-1'
fallback:
predicate: sqlDialect == "postgres"
ddl: |-
SELECT
region,
json_extract_path_text(Properties, 'Arn') as arn
FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer'
FROM awscc.cloud_control.resources WHERE TypeName = 'AWS::AccessAnalyzer::Analyzer'
AND region = 'us-east-1'
paths:
/?Action=CreateResource&Version=2021-09-30:
Expand Down
Loading