Skip to content

Commit c8b58da

Browse files
authored
Change master to main (opensearch-project#551)
Signed-off-by: Chen Dai <[email protected]>
1 parent 8f3e661 commit c8b58da

14 files changed

+20
-21
lines changed

.github/workflows/sql-cli-release-workflow.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Release SQL CLI Artifacts
2-
# This workflows is triggered on creating tags to master
2+
# This workflows is triggered on creating tags to main
33
on:
44
push:
55
tags:

.github/workflows/sql-jdbc-release-workflow.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Build and Release SQL-JDBC
2-
# This workflow is triggered on creating tags to master or an opensearch release branch
2+
# This workflow is triggered on creating tags to main or an opensearch release branch
33
on:
44
push:
55
tags:

.github/workflows/sql-release-workflow.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Release SQL Artifacts
2-
# This workflow is triggered on creating tags to master or an opensearch release branch
2+
# This workflow is triggered on creating tags to main or an opensearch release branch
33
on:
44
push:
55
tags:

DEVELOPER_GUIDE.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,16 @@ Now you can check out the code from your forked GitHub repository and create a n
4646
$ git clone [email protected]:<your_account>/sql.git
4747
$ git checkout -b <branch_name>
4848

49-
If there is update in master or you want to keep the forked repository long living, you can sync it by following the instructions: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork. Basically you just need to pull latest changes from upstream master once you add it for the first time::
49+
If there is update in main or you want to keep the forked repository long living, you can sync it by following the instructions: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork. Basically you just need to pull latest changes from upstream main once you add it for the first time::
5050

51-
#Merge to your local master
51+
#Merge to your local main
5252
$ git fetch upstream
53-
$ git checkout master
54-
$ git merge upstream/master
53+
$ git checkout main
54+
$ git merge upstream/main
5555

5656
#Merge to your branch if any
5757
$ git checkout <branch_name>
58-
$ git merge master
58+
$ git merge main
5959

6060
After getting the source code as well as OpenSearch and OpenSearch Dashboards, your workspace layout may look like this::
6161

@@ -181,7 +181,7 @@ Note that other related project code has already merged into this single reposit
181181
Code Convention
182182
---------------
183183

184-
We’re integrated Checkstyle plugin into Gradle build: https://github.com/opensearch-project/sql/blob/master/config/checkstyle/google_checks.xml. So any violation will fail the build. You need to identify the offending code from Gradle error message and fix them and rerun the Gradle build. Here are the highlight of some Checkstyle rules:
184+
We’re integrated Checkstyle plugin into Gradle build: https://github.com/opensearch-project/sql/blob/main/config/checkstyle/google_checks.xml. So any violation will fail the build. You need to identify the offending code from Gradle error message and fix them and rerun the Gradle build. Here are the highlight of some Checkstyle rules:
185185

186186
* 2 spaces indentation.
187187
* No line starts with tab character in source file.

docs/attributions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Apart from the problems we identified earlier, we made significant improvement i
2222

2323
1. *Integration Test*: We migrated all integrate tests to standard OpenSearch IT framework which spins up in-memory cluster for testing. Now all test cases treat plugin code as blackbox and verify functionality from externally.
2424
2. *New JDBC Driver*: We developed our own JDBC driver without any dependency on Elasticsearch proprietary code.
25-
[sql-jdbc](https://github.com/opensearch-project/sql/tree/master/sql-jdbc)
25+
[sql-jdbc](https://github.com/opensearch-project/sql/tree/main/sql-jdbc)
2626
3. *Better Hash JOIN*: Block Hash Join implementation with circuit break mechanism protect your OpenSearch memory. Performance testing showed our implementation is 1.5 ~ 2x better than old hash join in terms of throughput and latency and much lower error rate under heavy pressure.
2727
4. *Query Planner*: Logical and physical planner was added to support JOIN query in efficient and extendible way.
2828
5. *PartiQL Compatibility*: we are partially compatible with PartiQL specification which allows for query involved in nested JSON documents.

docs/dev/Architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
---
44
## 1.Overview
55

6-
The OpenSearch SQL (OD-SQL) project is developed based on NLPChina project (https://github.com/NLPchina/elasticsearch-sql) which has been deprecated now ([attributions](https://github.com/opensearch-project/sql/blob/master/docs/attributions.md)). Over the one year in development, a lot of features have been added to the OD-SQL project on top of the existing older NLPChina project. The purpose of this document is to explain the OD-SQL current architecture going ahead.
6+
The OpenSearch SQL (OD-SQL) project is developed based on NLPChina project (https://github.com/NLPchina/elasticsearch-sql) which has been deprecated now ([attributions](https://github.com/opensearch-project/sql/blob/main/docs/attributions.md)). Over the one year in development, a lot of features have been added to the OD-SQL project on top of the existing older NLPChina project. The purpose of this document is to explain the OD-SQL current architecture going ahead.
77

88
---
99
## 2.High Level View

docs/dev/Doctest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The reason we are not using OpenSearch test framework, is due to the difficulty
9898
1. bootstrap
9999
2. StartOpenSearch
100100
1. ` ./gradlew run`
101-
2. https://github.com/elastic/elasticsearch/blob/master/TESTING.asciidoc#running-elasticsearch-from-a-checkout
101+
2. https://github.com/elastic/elasticsearch/blob/main/TESTING.asciidoc#running-elasticsearch-from-a-checkout
102102
3. doctest
103103
4. StopOpenSearch
104104
4. Integrate Doctest to project gradle build, which means `./gradlew build` will also run `doctest`

docs/presentations/20201116-sql-demo.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Contribution: https://github.com/opendistro-for-elasticsearch/sql/blob/develop/d
108108
1. SQL reference manual
109109
1. https://opendistro.github.io/for-elasticsearch-docs/docs/sql/
110110
2. https://github.com/opendistro-for-elasticsearch/sql/blob/develop/docs/user/index.rst
111-
2. Setting for enabling new SQL engine: https://github.com/opendistro-for-elasticsearch/sql/blob/master/docs/user/admin/settings.rst#opendistro-sql-engine-new-enabled
111+
2. Setting for enabling new SQL engine: https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst#opendistrosqlenginenewenabled
112112

113113
### (II) Demo Cluster Setup
114114

plugin/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@ tasks.withType(licenseHeaders.class) {
9494
forbiddenApis.ignoreFailures = true
9595
// TODO: fix forbidden code patterns
9696
// introduced by OpenSearch plugin
97-
// see https://github.com/elastic/elasticsearch/blob/master/buildSrc/src/main/java/org/elasticsearch/gradle/precommit/ForbiddenPatternsTask.java
9897
forbiddenPatterns {
9998
setEnabled(false)
10099
}

sql-cli/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,13 @@ You can also configure the following connection properties:
8888
* Amazon OpenSearch Service domain with [Fine Grained Access Control](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html) enabled
8989
* `--aws-auth`: Turns on AWS sigV4 authentication to connect to an Amazon Elasticsearch Service endpoint. Use with the AWS CLI (`aws configure`) to retrieve the local AWS configuration to authenticate and connect.
9090
91-
For a list of all available configurations, see [clirc](https://github.com/opensearch-project/sql/blob/master/sql-cli/src/opensearch_sql_cli/conf/clirc).
91+
For a list of all available configurations, see [clirc](https://github.com/opensearch-project/sql/blob/main/sql-cli/src/opensearch_sql_cli/conf/clirc).
9292
9393
9494
9595
## Using the CLI
9696
97-
1. Save the sample [accounts test data](https://github.com/opensearch-project/sql/blob/master/integ-test/src/test/resources/accounts.json) file.
97+
1. Save the sample [accounts test data](https://github.com/opensearch-project/sql/blob/main/integ-test/src/test/resources/accounts.json) file.
9898
2. Index the sample data.
9999
100100
```

sql-jdbc/docs/tableau.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
* Download and install [Tableau Desktop](https://www.tableau.com/en-ca/products/desktop/download).
66
* Install and configure [OpenSearch](https://docs-beta.opensearch.org/opensearch/install/index/).
7-
* Download the [OpenSearch JDBC Driver](https://github.com/opensearch-project/sql/blob/master/sql-jdbc/README.md#download-and-installation).
7+
* Download the [OpenSearch JDBC Driver](https://github.com/opensearch-project/sql/blob/main/sql-jdbc/README.md#download-and-installation).
88

99
## Setup
1010

@@ -47,7 +47,7 @@ For futher details check [using a .tdc file with Tableau](https://kb.tableau.com
4747
### Connection information
4848

4949
You will need:
50-
* [JDBC connection string](https://github.com/opensearch-project/sql/blob/master/sql-jdbc/README.md#connection-url-and-other-settings) to enter in the URL field when you connect.
50+
* [JDBC connection string](https://github.com/opensearch-project/sql/blob/main/sql-jdbc/README.md#connection-url-and-other-settings) to enter in the URL field when you connect.
5151

5252
Sample connection string for connecting to localhost: `jdbc:opensearch://localhost:9200`.
5353

sql-odbc/THIRD-PARTY

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
** Visual Leak Detector -- https://github.com/KindDragon/vld
55
** PostgreSQL v12.0 -- https://www.postgresql.org/ftp/source/v12.0/
66
** Googletest -- https://github.com/google/googletest
7-
** StableCoder - code-coverage.cmake -- https://github.com/StableCoder/cmake-scripts/blob/master/code-coverage.cmake
7+
** StableCoder - code-coverage.cmake -- https://github.com/StableCoder/cmake-scripts/blob/main/code-coverage.cmake
88

99
Apache License
1010

sql-odbc/docs/dev/run_tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The **Test Runner** has been tried and tested with [Python3.7.6](https://www.pyt
8787

8888
### Run with Coverage (Mac only)
8989

90-
(using a CMake script provided by George Cave (StableCoder) under the Apache 2.0 license, found [here](https://github.com/StableCoder/cmake-scripts/blob/master/code-coverage.cmake))
90+
(using a CMake script provided by George Cave (StableCoder) under the Apache 2.0 license, found [here](https://github.com/StableCoder/cmake-scripts/blob/main/code-coverage.cmake))
9191

9292
#### Requirements
9393
* `llvm-cov` in your PATH environment variable

workbench/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ reported the issue. Please try to include as much information as you can. Detail
2323
## Contributing via Pull Requests
2424
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
2525

26-
1. You are working against the latest source on the *master* branch.
26+
1. You are working against the latest source on the *main* branch.
2727
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
2828
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
2929

0 commit comments

Comments
 (0)